@inferencesh/sdk 0.27.0 → 0.29.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/dist/types.d.ts CHANGED
@@ -266,14 +266,6 @@ export interface MCPToolConfigDTO {
266
266
  tool_name: string;
267
267
  credential_id?: string;
268
268
  }
269
- /**
270
- * AgentImages contains display images for an agent
271
- */
272
- export interface AgentImages {
273
- card: string;
274
- thumbnail: string;
275
- banner: string;
276
- }
277
269
  /**
278
270
  * CoreAppConfigDTO references an app used as the agent's core
279
271
  */
@@ -295,7 +287,7 @@ export interface AgentDTO extends BaseModelDTO, PermissionModelDTO, ProjectModel
295
287
  * Title is the human-readable name; empty falls back to Name.
296
288
  */
297
289
  title: string;
298
- images: AgentImages;
290
+ images: ResourceImages;
299
291
  version_id: string;
300
292
  version?: AgentVersionDTO;
301
293
  /**
@@ -345,7 +337,7 @@ export interface CreateAgentRequest {
345
337
  id?: string;
346
338
  name: string;
347
339
  title?: string;
348
- images?: AgentImages;
340
+ images?: ResourceImages;
349
341
  visibility?: Visibility;
350
342
  /**
351
343
  * Harness runs the agent: "inference" (ours) or an external harness.
@@ -572,7 +564,7 @@ export interface CreateAppRequest {
572
564
  description?: string;
573
565
  agent_description?: string;
574
566
  category?: AppCategory;
575
- images?: AppImages;
567
+ images?: ResourceImages;
576
568
  /**
577
569
  * Tags replace the app's tags when given; omitted, a deploy takes them
578
570
  * from the version's metadata.tags, and keeps the stored ones if that is
@@ -773,6 +765,12 @@ export interface SecretCreateRequest {
773
765
  */
774
766
  provider_name?: string;
775
767
  provider_website?: string;
768
+ /**
769
+ * Label names this key among the owner's keys for Provider (prod,
770
+ * personal): a new label adds a key beside the others, the same label
771
+ * replaces that key's value. Empty: the owner's default key.
772
+ */
773
+ label?: string;
776
774
  }
777
775
  /**
778
776
  * SecretProviderRequest attaches an existing secret to a provider's
@@ -784,6 +782,11 @@ export interface SecretProviderRequest {
784
782
  connection_scope?: CredentialScope;
785
783
  provider_name?: string;
786
784
  provider_website?: string;
785
+ /**
786
+ * Label names the key among the owner's keys for Provider, as on
787
+ * SecretCreateRequest. Empty: the owner's default key.
788
+ */
789
+ label?: string;
787
790
  }
788
791
  export interface SecretUpdateRequest {
789
792
  value: string;
@@ -1103,7 +1106,7 @@ export declare const ScopeSecretsWrite: Scope;
1103
1106
  export declare const ScopeSecretsReveal: Scope;
1104
1107
  /**
1105
1108
  * Action-level scopes for credentials (connected accounts, vaults,
1106
- * auth schemes, MCP servers).
1109
+ * auth providers, MCP servers).
1107
1110
  */
1108
1111
  export declare const ScopeCredentialsRead: Scope;
1109
1112
  /**
@@ -1426,14 +1429,6 @@ export interface AppFunction {
1426
1429
  */
1427
1430
  annotations?: ToolAnnotations;
1428
1431
  }
1429
- /**
1430
- * AppImages holds developer-provided images for the app.
1431
- */
1432
- export interface AppImages {
1433
- card: string;
1434
- thumbnail: string;
1435
- banner: string;
1436
- }
1437
1432
  /**
1438
1433
  * AppGPUResource describes GPU requirements.
1439
1434
  */
@@ -1465,7 +1460,7 @@ export interface SecretRequirement {
1465
1460
  * the platform-defined grants it needs ("x.tweet.read", "google.sheets":
1466
1461
  * an OAuth grant with the scopes it implies), each a capability of the
1467
1462
  * entry's own provider. Provider seeds the catalog row for the company the
1468
- * first time it is seen and never overwrites it; Auth seeds the auth scheme
1463
+ * first time it is seen and never overwrites it; Auth seeds the auth provider
1469
1464
  * when the slug is free.
1470
1465
  * credentials:
1471
1466
  * slack:
@@ -1489,17 +1484,17 @@ export interface CredentialRequirement {
1489
1484
  * catalog row that does not exist yet. Its slug defaults to the
1490
1485
  * credential slug.
1491
1486
  */
1492
- provider?: ProviderSeed;
1487
+ provider?: CompanySeed;
1493
1488
  /**
1494
- * Auth is the credential's auth scheme, for a slug no row defines yet.
1489
+ * Auth is the credential's auth provider, for a slug no row defines yet.
1495
1490
  */
1496
- auth?: AuthSchemeSpec;
1491
+ auth?: AuthMethod;
1497
1492
  }
1498
1493
  /**
1499
- * ProviderSeed is a provider (the company behind a credential) as an app
1494
+ * CompanySeed is a provider (the company behind a credential) as an app
1500
1495
  * declares it: enough to create its catalog row when none exists.
1501
1496
  */
1502
- export interface ProviderSeed {
1497
+ export interface CompanySeed {
1503
1498
  slug?: string;
1504
1499
  name?: string;
1505
1500
  description?: string;
@@ -1531,7 +1526,7 @@ export interface AppDTO extends BaseModelDTO, PermissionModelDTO {
1531
1526
  description: string;
1532
1527
  agent_description: string;
1533
1528
  category: AppCategory;
1534
- images: AppImages;
1529
+ images: ResourceImages;
1535
1530
  /**
1536
1531
  * Tags name what the app does and its traits, as lowercase slugs
1537
1532
  * (text-to-image, open-weights). GET /store/tags lists the ones in use
@@ -1634,7 +1629,7 @@ export interface AppVersionDTO extends BaseModelDTO {
1634
1629
  export interface DeployWarning {
1635
1630
  /**
1636
1631
  * Code identifies the check: readonly_broad_credential,
1637
- * unused_credential, missing_annotations.
1632
+ * unused_credential, missing_annotations, unapproved_platform_scope.
1638
1633
  */
1639
1634
  code: string;
1640
1635
  /**
@@ -1702,25 +1697,13 @@ export interface PublicAppStoreDTO {
1702
1697
  */
1703
1698
  title: string;
1704
1699
  description: string;
1705
- images: AppImages;
1700
+ images: ResourceImages;
1706
1701
  is_featured: boolean;
1707
1702
  rank: number;
1708
1703
  has_approved_version: boolean;
1709
1704
  page_id?: string;
1710
1705
  pricing_description?: string;
1711
1706
  }
1712
- /**
1713
- * ResourceImages is the display-image set every listable resource carries:
1714
- * a card image for grids, a thumbnail for dense rows, a banner for headers.
1715
- * AppImages and AgentImages predate this and hold the same three fields;
1716
- * they should collapse onto this type, but aliasing them changes what
1717
- * gotypegen emits for existing consumers, so that migration is separate.
1718
- */
1719
- export interface ResourceImages {
1720
- card: string;
1721
- thumbnail: string;
1722
- banner: string;
1723
- }
1724
1707
  /**
1725
1708
  * ArtifactDTO is the API shape of an artifact entry.
1726
1709
  */
@@ -1751,6 +1734,12 @@ export interface ArtifactDTO extends BaseModelDTO, PermissionModelDTO {
1751
1734
  * SharedVersionID pins the version viewers see. Empty = always latest.
1752
1735
  */
1753
1736
  shared_version_id?: string;
1737
+ /**
1738
+ * CoverVersionID is the version a captured cover shows. Empty means the
1739
+ * cover (if any) was set by a person or agent, and a capture never
1740
+ * replaces it.
1741
+ */
1742
+ cover_version_id?: string;
1754
1743
  /**
1755
1744
  * Capabilities declared by the latest version (runtime features the page
1756
1745
  * may use). Reserved for the artifact runtime; opaque to the API.
@@ -1763,6 +1752,11 @@ export interface ArtifactDTO extends BaseModelDTO, PermissionModelDTO {
1763
1752
  * URL is the canonical viewer URL for this artifact.
1764
1753
  */
1765
1754
  url?: string;
1755
+ /**
1756
+ * Access is the viewer's level on this artifact: read, interact (may
1757
+ * change its data) or write (may edit it). Set on single reads only.
1758
+ */
1759
+ access?: Permission;
1766
1760
  }
1767
1761
  /**
1768
1762
  * ArtifactVersionDTO is one immutable publish of an artifact.
@@ -1797,6 +1791,32 @@ export interface ArtifactVersionDTO extends BaseModelDTO {
1797
1791
  [key: string]: any;
1798
1792
  };
1799
1793
  created_by_user_id?: string;
1794
+ /**
1795
+ * Files are the pages and data served beside the index page.
1796
+ */
1797
+ files?: ArtifactVersionFileDTO[];
1798
+ }
1799
+ /**
1800
+ * ArtifactVersionFileDTO is one file published beside a version's index.
1801
+ */
1802
+ export interface ArtifactVersionFileDTO {
1803
+ path: string;
1804
+ size_bytes: number;
1805
+ content_type: string;
1806
+ }
1807
+ /**
1808
+ * ArtifactFileInput is one extra file in a publish, served at Path relative
1809
+ * to the index page: another page (.html, .md), or css, js, json, svg, txt,
1810
+ * xml, csv.
1811
+ */
1812
+ export interface ArtifactFileInput {
1813
+ path: string;
1814
+ content: string;
1815
+ /**
1816
+ * ContentEncoding is "base64" when Content is base64-encoded, as for the
1817
+ * main content.
1818
+ */
1819
+ content_encoding?: string;
1800
1820
  }
1801
1821
  /**
1802
1822
  * ArtifactCreateRequest is the body for POST /artifacts. Creates the entry
@@ -1822,6 +1842,11 @@ export interface ArtifactCreateRequest {
1822
1842
  * from browsers and CLIs: edge firewalls reject raw <script> in JSON bodies.
1823
1843
  */
1824
1844
  content_encoding?: string;
1845
+ /**
1846
+ * Files are published beside the index page. A publish is the whole
1847
+ * site: files of the previous version are not carried over.
1848
+ */
1849
+ files?: ArtifactFileInput[];
1825
1850
  label?: string;
1826
1851
  notes?: string;
1827
1852
  origin?: string;
@@ -1868,6 +1893,11 @@ export interface ArtifactPublishRequest {
1868
1893
  * ContentEncoding is "base64" when Content is base64-encoded UTF-8.
1869
1894
  */
1870
1895
  content_encoding?: string;
1896
+ /**
1897
+ * Files are published beside the index page. A publish is the whole
1898
+ * site: files of the previous version are not carried over.
1899
+ */
1900
+ files?: ArtifactFileInput[];
1871
1901
  label?: string;
1872
1902
  notes?: string;
1873
1903
  origin?: string;
@@ -1938,9 +1968,25 @@ export interface ArtifactDataRequest {
1938
1968
  [key: string]: any;
1939
1969
  };
1940
1970
  /**
1941
- * Limit caps a list; the server clamps it.
1971
+ * Limit caps a list; the server clamps it to 200.
1942
1972
  */
1943
1973
  limit?: number;
1974
+ /**
1975
+ * Cursor continues a list from the next_cursor of the page before.
1976
+ */
1977
+ cursor?: string;
1978
+ /**
1979
+ * Order is the list order: -updated_at (the default), updated_at,
1980
+ * -created_at or created_at.
1981
+ */
1982
+ order?: string;
1983
+ /**
1984
+ * Where keeps only documents whose top-level fields equal these values
1985
+ * (string, number, boolean, or null for a missing field).
1986
+ */
1987
+ where?: {
1988
+ [key: string]: any;
1989
+ };
1944
1990
  }
1945
1991
  /**
1946
1992
  * ArtifactDataListResponse is a page of documents from one collection.
@@ -1949,6 +1995,10 @@ export interface ArtifactDataListResponse {
1949
1995
  collection: string;
1950
1996
  documents: ArtifactDataDTO[];
1951
1997
  count: number;
1998
+ /**
1999
+ * NextCursor fetches the page after this one; empty on the last page.
2000
+ */
2001
+ next_cursor?: string;
1952
2002
  }
1953
2003
  /**
1954
2004
  * ArtifactViewerDTO is what the user capability tells a page about whoever
@@ -2064,6 +2114,21 @@ export interface ResourceStatusDTO {
2064
2114
  status: any;
2065
2115
  updated_at: string;
2066
2116
  }
2117
+ /**
2118
+ * ResourceImages is the display-image set every listable resource carries
2119
+ * (apps, agents, artifacts): a card image for grids, a thumbnail for dense
2120
+ * rows, a banner for headers.
2121
+ */
2122
+ export interface ResourceImages {
2123
+ card: string;
2124
+ thumbnail: string;
2125
+ banner: string;
2126
+ /**
2127
+ * Dark holds the same slots for a dark theme. Nil means the slots above
2128
+ * serve both themes.
2129
+ */
2130
+ dark?: ResourceImages;
2131
+ }
2067
2132
  /**
2068
2133
  * AvailabilityResponse answers "can I use this name?" — for page slugs, team
2069
2134
  * usernames and voucher codes alike.
@@ -2268,6 +2333,10 @@ export interface ChatMessageDTO extends BaseModelDTO, PermissionModelDTO {
2268
2333
  tools?: Tool[];
2269
2334
  tool_call_id?: string;
2270
2335
  tool_invocations?: ToolInvocationDTO[];
2336
+ /**
2337
+ * CompactionMeta is what a compaction (role compaction) retired.
2338
+ */
2339
+ compaction_meta?: CompactionMeta;
2271
2340
  }
2272
2341
  /**
2273
2342
  * PolicyRuleDTO is one rule, typed form Kind[selector](specifier).
@@ -2520,6 +2589,12 @@ export interface CredentialDTO extends BaseModelDTO, PermissionModelDTO {
2520
2589
  account_identifier?: string;
2521
2590
  account_name?: string;
2522
2591
  scopes: StringSlice;
2592
+ /**
2593
+ * AllowedScopes, on an OAuth app row (grant credentials), is every
2594
+ * scope a login through it may request; absent when any scope may be
2595
+ * (a team's own client by default). Never set on a login.
2596
+ */
2597
+ allowed_scopes?: StringSlice;
2523
2598
  expires_at?: string;
2524
2599
  vault_id?: string;
2525
2600
  metadata?: {
@@ -2527,17 +2602,34 @@ export interface CredentialDTO extends BaseModelDTO, PermissionModelDTO {
2527
2602
  };
2528
2603
  is_primary: boolean;
2529
2604
  error_message?: string;
2605
+ /**
2606
+ * Secrets are the secret rows linked to the credential (a key's values),
2607
+ * by row and key, never by value. Filled on the vault's api_key configs
2608
+ * and the admin provider tree.
2609
+ */
2610
+ secrets?: CredentialSecretRef[];
2530
2611
  }
2531
2612
  /**
2532
- * ProviderSummary is the company a credential slug belongs to: the
2613
+ * CredentialSecretRef names one secret linked to a credential: the row's
2614
+ * id, the key it is stored under and when its value last changed.
2615
+ */
2616
+ export interface CredentialSecretRef {
2617
+ id: string;
2618
+ key: string;
2619
+ updated_at: string;
2620
+ }
2621
+ /**
2622
+ * CompanySummary is the company a credential slug belongs to: the
2533
2623
  * providers row's identity, for grouping and display.
2534
2624
  */
2535
- export interface ProviderSummary {
2625
+ export interface CompanySummary {
2536
2626
  slug: string;
2537
2627
  name: string;
2538
2628
  icon_url?: string;
2539
2629
  website?: string;
2540
2630
  docs_url?: string;
2631
+ terms_url?: string;
2632
+ privacy_url?: string;
2541
2633
  }
2542
2634
  /**
2543
2635
  * CredentialConfigDTO is the merged view: provider catalog + credential state.
@@ -2546,14 +2638,14 @@ export interface CredentialConfigDTO {
2546
2638
  slug: string;
2547
2639
  /**
2548
2640
  * Provider is the credential slug (what Credential.Provider stores):
2549
- * one way to authenticate. The company it belongs to is ProviderInfo.
2641
+ * one way to authenticate. The company it belongs to is Company.
2550
2642
  */
2551
2643
  provider: string;
2552
2644
  /**
2553
- * ProviderInfo is the company this slug belongs to, for grouping: the
2554
- * providers row its auth scheme names, else the slug's own identity.
2645
+ * Company is the company this slug belongs to, for grouping: the
2646
+ * companies row its auth provider names, else the slug's own identity.
2555
2647
  */
2556
- provider_info?: ProviderSummary;
2648
+ company?: CompanySummary;
2557
2649
  type: string;
2558
2650
  name: string;
2559
2651
  short_name: string;
@@ -2579,10 +2671,10 @@ export interface CredentialConfigDTO {
2579
2671
  */
2580
2672
  app?: CredentialDTO;
2581
2673
  /**
2582
- * AuthSchemeID is set when the provider is one the team defined
2583
- * itself (models.AuthScheme), so the UI can offer edit and remove.
2674
+ * AuthProviderID is set when the provider is one the team defined
2675
+ * itself (models.AuthProvider), so the UI can offer edit and remove.
2584
2676
  */
2585
- auth_scheme_id?: string;
2677
+ auth_provider_id?: string;
2586
2678
  /**
2587
2679
  * Credential is the login used where no account is named: the caller's
2588
2680
  * own, else the workspace's default account.
@@ -2594,6 +2686,12 @@ export interface CredentialConfigDTO {
2594
2686
  * connected.
2595
2687
  */
2596
2688
  accounts?: (CredentialDTO | undefined)[];
2689
+ /**
2690
+ * MultiAccount: several accounts of this provider can be connected side
2691
+ * by side, each addressed by its account_id; the default (is_primary) is
2692
+ * used where none is named.
2693
+ */
2694
+ multi_account: boolean;
2597
2695
  }
2598
2696
  /**
2599
2697
  * SecretFieldConfig defines a secret field for the UI
@@ -2713,9 +2811,38 @@ export interface EngineDTO extends BaseModelDTO, PermissionModelDTO {
2713
2811
  api_url: string;
2714
2812
  status: EngineStatus;
2715
2813
  engine_version: string;
2814
+ /**
2815
+ * EnginePin is the version the engine is held on; empty follows stable.
2816
+ */
2817
+ engine_pin?: string;
2818
+ /**
2819
+ * Capabilities are what the engine last reported it can do.
2820
+ */
2821
+ capabilities?: EngineCapabilities;
2716
2822
  system_info?: SystemInfo;
2717
2823
  workers: (WorkerDTO | undefined)[];
2718
2824
  }
2825
+ /**
2826
+ * EngineUpdateRequest names the release an engine should install: "stable",
2827
+ * "canary", or a version such as v1.9.3. Empty is stable.
2828
+ */
2829
+ export interface EngineUpdateRequest {
2830
+ version?: string;
2831
+ }
2832
+ /**
2833
+ * EngineRelease is one published engine build.
2834
+ */
2835
+ export interface EngineRelease {
2836
+ version: string;
2837
+ release_date?: string;
2838
+ }
2839
+ /**
2840
+ * EngineReleasesResponse is the head of each engine release channel.
2841
+ */
2842
+ export interface EngineReleasesResponse {
2843
+ stable?: EngineRelease;
2844
+ canary?: EngineRelease;
2845
+ }
2719
2846
  /**
2720
2847
  * EngineSummary is a lightweight engine response embedded in tasks.
2721
2848
  */
@@ -2794,6 +2921,19 @@ export interface WorkerRAM {
2794
2921
  worker_id: string;
2795
2922
  total: number;
2796
2923
  }
2924
+ /**
2925
+ * EngineCapability is something an engine can do beyond the base contract
2926
+ * every engine meets. An engine reports the ones it has (EngineTelemetry);
2927
+ * a task lists the ones it needs (Task.Requires); the scheduler only sends
2928
+ * a task to an engine that has every one it needs.
2929
+ */
2930
+ export type EngineCapability = "egress_gateway";
2931
+ export declare const EngineCapabilityEgressGateway: EngineCapability;
2932
+ /**
2933
+ * EngineCapabilities is a set of capabilities, kept as a list. Nil and
2934
+ * empty are the same: nothing beyond the base contract.
2935
+ */
2936
+ export type EngineCapabilities = EngineCapability[];
2797
2937
  /**
2798
2938
  * EntitlementDTO for API responses
2799
2939
  */
@@ -4641,6 +4781,26 @@ export interface SecretDTO extends BaseModelDTO, PermissionModelDTO {
4641
4781
  * a plain secret.
4642
4782
  */
4643
4783
  credential_id?: string;
4784
+ /**
4785
+ * The four below are read from the credential a listing preloads; a
4786
+ * row read without it leaves them empty.
4787
+ * Provider is the slug of the credential the secret belongs to.
4788
+ */
4789
+ provider?: string;
4790
+ /**
4791
+ * ProviderName is that credential's display name ("Anthropic").
4792
+ */
4793
+ provider_name?: string;
4794
+ /**
4795
+ * Label is the credential's account identifier: a key's label.
4796
+ */
4797
+ label?: string;
4798
+ /**
4799
+ * CredentialDefault is whether the credential is its owner's default.
4800
+ * Always serialised: a linked non-default row and an unlabelled row
4801
+ * must not read the same.
4802
+ */
4803
+ credential_default: boolean;
4644
4804
  }
4645
4805
  /**
4646
4806
  * SensitiveString is a string type that prevents accidental exposure of secrets.
@@ -5536,58 +5696,58 @@ export declare const GPUTypeNvidia: GPUType;
5536
5696
  export declare const GPUTypeAMD: GPUType;
5537
5697
  export declare const GPUTypeApple: GPUType;
5538
5698
  /**
5539
- * AuthSchemeKind is how a provider authenticates: the kinds of an OpenAPI
5699
+ * AuthMethodKind is how a provider authenticates: the kinds of an OpenAPI
5540
5700
  * Security Scheme Object (oauth2, apiKey, http), named the same so a
5541
5701
  * vendor's spec maps onto a scheme without translation.
5542
5702
  */
5543
- export type AuthSchemeKind = "oauth2" | "api_key" | "http" | "oauth2_authorization_code";
5703
+ export type AuthMethodKind = "oauth2" | "api_key" | "http" | "oauth2_authorization_code";
5544
5704
  /**
5545
- * AuthSchemeOAuth2 is OAuth 2.0; Flow says which grant.
5705
+ * AuthMethodOAuth2 is OAuth 2.0; Flow says which grant.
5546
5706
  */
5547
- export declare const AuthSchemeOAuth2: AuthSchemeKind;
5707
+ export declare const AuthMethodOAuth2: AuthMethodKind;
5548
5708
  /**
5549
- * AuthSchemeAPIKey is one or more keys a person pastes, sent as a
5709
+ * AuthMethodAPIKey is one or more keys a person pastes, sent as a
5550
5710
  * header or query parameter.
5551
5711
  */
5552
- export declare const AuthSchemeAPIKey: AuthSchemeKind;
5712
+ export declare const AuthMethodAPIKey: AuthMethodKind;
5553
5713
  /**
5554
- * AuthSchemeHTTP is a pasted secret sent as an HTTP auth scheme
5714
+ * AuthMethodHTTP is a pasted secret sent as an HTTP auth provider
5555
5715
  * (Authorization: Bearer or Basic).
5556
5716
  */
5557
- export declare const AuthSchemeHTTP: AuthSchemeKind;
5717
+ export declare const AuthMethodHTTP: AuthMethodKind;
5558
5718
  /**
5559
- * Deprecated: the kind is AuthSchemeOAuth2 with AuthSchemeFlowAuthorizationCode.
5719
+ * Deprecated: the kind is AuthMethodOAuth2 with AuthMethodFlowAuthorizationCode.
5560
5720
  * Same value, so comparisons keep working; rows still stored as
5561
5721
  * "oauth2_authorization_code" are read as oauth2 (UnmarshalJSON).
5562
5722
  */
5563
- export declare const AuthSchemeOAuth2AuthorizationCode: "oauth2";
5723
+ export declare const AuthMethodOAuth2AuthorizationCode: "oauth2";
5564
5724
  /**
5565
- * AuthSchemeFlow is the OAuth 2.0 grant an oauth2 scheme uses.
5725
+ * AuthMethodFlow is the OAuth 2.0 grant an oauth2 scheme uses.
5566
5726
  */
5567
- export type AuthSchemeFlow = "authorization_code" | "client_credentials";
5727
+ export type AuthMethodFlow = "authorization_code" | "client_credentials";
5568
5728
  /**
5569
- * AuthSchemeFlowAuthorizationCode is the user-consent flow: authorization
5729
+ * AuthMethodFlowAuthorizationCode is the user-consent flow: authorization
5570
5730
  * endpoint → code → token endpoint, optionally with PKCE. The default.
5571
5731
  */
5572
- export declare const AuthSchemeFlowAuthorizationCode: AuthSchemeFlow;
5732
+ export declare const AuthMethodFlowAuthorizationCode: AuthMethodFlow;
5573
5733
  /**
5574
- * AuthSchemeFlowClientCredentials is server-to-server: the app's client
5734
+ * AuthMethodFlowClientCredentials is server-to-server: the app's client
5575
5735
  * id and secret are exchanged at the token endpoint, no redirect, no
5576
5736
  * user. The login is the app's own.
5577
5737
  */
5578
- export declare const AuthSchemeFlowClientCredentials: AuthSchemeFlow;
5738
+ export declare const AuthMethodFlowClientCredentials: AuthMethodFlow;
5579
5739
  /**
5580
- * AuthSchemeAPIKeyIn is where an api_key scheme's key travels.
5740
+ * AuthMethodAPIKeyIn is where an api_key scheme's key travels.
5581
5741
  */
5582
- export type AuthSchemeAPIKeyIn = "header" | "query";
5583
- export declare const AuthSchemeAPIKeyInHeader: AuthSchemeAPIKeyIn;
5584
- export declare const AuthSchemeAPIKeyInQuery: AuthSchemeAPIKeyIn;
5742
+ export type AuthMethodAPIKeyIn = "header" | "query";
5743
+ export declare const AuthMethodAPIKeyInHeader: AuthMethodAPIKeyIn;
5744
+ export declare const AuthMethodAPIKeyInQuery: AuthMethodAPIKeyIn;
5585
5745
  /**
5586
- * AuthSchemeHTTPScheme is the Authorization scheme of an http scheme.
5746
+ * AuthMethodHTTPScheme is the Authorization scheme of an http scheme.
5587
5747
  */
5588
- export type AuthSchemeHTTPScheme = "bearer" | "basic";
5589
- export declare const AuthSchemeHTTPBearer: AuthSchemeHTTPScheme;
5590
- export declare const AuthSchemeHTTPBasic: AuthSchemeHTTPScheme;
5748
+ export type AuthMethodHTTPScheme = "bearer" | "basic";
5749
+ export declare const AuthMethodHTTPBearer: AuthMethodHTTPScheme;
5750
+ export declare const AuthMethodHTTPBasic: AuthMethodHTTPScheme;
5591
5751
  /**
5592
5752
  * SecretField is one value a person pastes to connect an api_key or http
5593
5753
  * scheme: its vault key and how the form asks for it. Several fields make
@@ -5601,62 +5761,62 @@ export interface SecretField {
5601
5761
  optional?: boolean;
5602
5762
  }
5603
5763
  /**
5604
- * AuthSchemeClientAuth is how client_id/client_secret reach the token
5764
+ * AuthMethodClientAuth is how client_id/client_secret reach the token
5605
5765
  * endpoint. Most providers accept either; a few insist on one.
5606
5766
  */
5607
- export type AuthSchemeClientAuth = "basic" | "body" | "none";
5767
+ export type AuthMethodClientAuth = "basic" | "body" | "none";
5608
5768
  /**
5609
- * AuthSchemeClientAuthBasic sends them as an HTTP Basic Authorization
5769
+ * AuthMethodClientAuthBasic sends them as an HTTP Basic Authorization
5610
5770
  * header (RFC 6749 §2.3.1, the default).
5611
5771
  */
5612
- export declare const AuthSchemeClientAuthBasic: AuthSchemeClientAuth;
5772
+ export declare const AuthMethodClientAuthBasic: AuthMethodClientAuth;
5613
5773
  /**
5614
- * AuthSchemeClientAuthBody sends them as form fields in the request body.
5774
+ * AuthMethodClientAuthBody sends them as form fields in the request body.
5615
5775
  */
5616
- export declare const AuthSchemeClientAuthBody: AuthSchemeClientAuth;
5776
+ export declare const AuthMethodClientAuthBody: AuthMethodClientAuth;
5617
5777
  /**
5618
- * AuthSchemeClientAuthNone is a public client (RFC 8414
5778
+ * AuthMethodClientAuthNone is a public client (RFC 8414
5619
5779
  * token_endpoint_auth_method "none"): the client id goes in the body,
5620
5780
  * there is no secret, and PKCE is what proves the client. Its OAuth app
5621
5781
  * is complete with a client id alone (a dynamically registered client,
5622
5782
  * or a Client ID Metadata Document URL).
5623
5783
  */
5624
- export declare const AuthSchemeClientAuthNone: AuthSchemeClientAuth;
5784
+ export declare const AuthMethodClientAuthNone: AuthMethodClientAuth;
5625
5785
  /**
5626
- * AuthSchemeTokenRequest is the token request's body encoding.
5786
+ * AuthMethodTokenRequest is the token request's body encoding.
5627
5787
  */
5628
- export type AuthSchemeTokenRequest = "form" | "json";
5629
- export declare const AuthSchemeTokenRequestForm: AuthSchemeTokenRequest;
5630
- export declare const AuthSchemeTokenRequestJSON: AuthSchemeTokenRequest;
5788
+ export type AuthMethodTokenRequest = "form" | "json";
5789
+ export declare const AuthMethodTokenRequestForm: AuthMethodTokenRequest;
5790
+ export declare const AuthMethodTokenRequestJSON: AuthMethodTokenRequest;
5631
5791
  /**
5632
- * AuthSchemeRefresh is when an access token is refreshed.
5792
+ * AuthMethodRefresh is when an access token is refreshed.
5633
5793
  */
5634
- export type AuthSchemeRefresh = "" | "always";
5794
+ export type AuthMethodRefresh = "" | "always";
5635
5795
  /**
5636
- * AuthSchemeRefreshWhenExpiring refreshes within five minutes of the
5796
+ * AuthMethodRefreshWhenExpiring refreshes within five minutes of the
5637
5797
  * reported expiry; a token with no expiry is treated as long-lived
5638
5798
  * (Slack without token rotation, Notion).
5639
5799
  */
5640
- export declare const AuthSchemeRefreshWhenExpiring: AuthSchemeRefresh;
5800
+ export declare const AuthMethodRefreshWhenExpiring: AuthMethodRefresh;
5641
5801
  /**
5642
- * AuthSchemeRefreshAlways refreshes on every read: the provider reports
5802
+ * AuthMethodRefreshAlways refreshes on every read: the provider reports
5643
5803
  * no expiry but the token does expire (Salesforce's session timeout is
5644
5804
  * per org and not reported).
5645
5805
  */
5646
- export declare const AuthSchemeRefreshAlways: AuthSchemeRefresh;
5806
+ export declare const AuthMethodRefreshAlways: AuthMethodRefresh;
5647
5807
  /**
5648
- * AuthSchemeRevokeStyle is how the token reaches the revoke endpoint.
5808
+ * AuthMethodRevokeStyle is how the token reaches the revoke endpoint.
5649
5809
  */
5650
- export type AuthSchemeRevokeStyle = "bearer" | "query" | "form";
5651
- export declare const AuthSchemeRevokeBearer: AuthSchemeRevokeStyle;
5652
- export declare const AuthSchemeRevokeQuery: AuthSchemeRevokeStyle;
5653
- export declare const AuthSchemeRevokeForm: AuthSchemeRevokeStyle;
5810
+ export type AuthMethodRevokeStyle = "bearer" | "query" | "form";
5811
+ export declare const AuthMethodRevokeBearer: AuthMethodRevokeStyle;
5812
+ export declare const AuthMethodRevokeQuery: AuthMethodRevokeStyle;
5813
+ export declare const AuthMethodRevokeForm: AuthMethodRevokeStyle;
5654
5814
  /**
5655
- * AuthSchemeRevoke is the optional token revocation on disconnect.
5815
+ * AuthMethodRevoke is the optional token revocation on disconnect.
5656
5816
  */
5657
- export interface AuthSchemeRevoke {
5817
+ export interface AuthMethodRevoke {
5658
5818
  url: string;
5659
- style: AuthSchemeRevokeStyle;
5819
+ style: AuthMethodRevokeStyle;
5660
5820
  /**
5661
5821
  * ClientAuth also sends client_id and client_secret in the form
5662
5822
  * (Discord).
@@ -5664,13 +5824,13 @@ export interface AuthSchemeRevoke {
5664
5824
  client_auth?: boolean;
5665
5825
  }
5666
5826
  /**
5667
- * AuthSchemeAppKey is one key of the OAuth app a login goes through. The
5827
+ * AuthMethodAppKey is one key of the OAuth app a login goes through. The
5668
5828
  * client id and secret are implied (PREFIX_CLIENT_ID, PREFIX_CLIENT_SECRET);
5669
5829
  * listing them only overrides their label and placeholder. Other keys
5670
5830
  * (bot_token, signing_secret, tenant_id) are optional extras the app holds,
5671
5831
  * read back by name in templates as {app.<name>} and by hooks.
5672
5832
  */
5673
- export interface AuthSchemeAppKey {
5833
+ export interface AuthMethodAppKey {
5674
5834
  /**
5675
5835
  * Name is the key's role: client_id, client_secret, bot_token, …
5676
5836
  */
@@ -5688,13 +5848,13 @@ export interface AuthSchemeAppKey {
5688
5848
  optional?: boolean;
5689
5849
  }
5690
5850
  /**
5691
- * AuthSchemeLookup is a call made after the token exchange, with the new
5851
+ * AuthMethodLookup is a call made after the token exchange, with the new
5692
5852
  * access token as bearer; its decoded response becomes a document root of
5693
5853
  * its name for the identity, metadata and later lookups ({user.email},
5694
5854
  * {resources.0.id}). userinfo_url is shorthand for the lookup named user.
5695
5855
  * URL, body and headers are templates.
5696
5856
  */
5697
- export interface AuthSchemeLookup {
5857
+ export interface AuthMethodLookup {
5698
5858
  name: string;
5699
5859
  url: string;
5700
5860
  method?: string;
@@ -5709,11 +5869,11 @@ export interface AuthSchemeLookup {
5709
5869
  };
5710
5870
  }
5711
5871
  /**
5712
- * AuthSchemeCapability is something an app can ask for from this provider,
5872
+ * AuthMethodCapability is something an app can ask for from this provider,
5713
5873
  * satisfied by a connection holding its scopes. Scopes are in the scheme's
5714
5874
  * own (friendly) names, the ones a credential stores.
5715
5875
  */
5716
- export interface AuthSchemeCapability {
5876
+ export interface AuthMethodCapability {
5717
5877
  key: string;
5718
5878
  scopes?: string[];
5719
5879
  satisfies?: string[];
@@ -5721,10 +5881,10 @@ export interface AuthSchemeCapability {
5721
5881
  description?: string;
5722
5882
  }
5723
5883
  /**
5724
- * AuthSchemeSpec is one way to authenticate against a provider, as data.
5884
+ * AuthMethod is one way to authenticate against a provider, as data.
5725
5885
  * Everything a standard OAuth2 provider needs is a field; where a provider
5726
5886
  * deviates in a way data cannot express, the spec names a hook and Go
5727
- * supplies it (authprovider.RegisterTokenResponseHook and friends).
5887
+ * supplies it (authmethod.RegisterTokenResponseHook and friends).
5728
5888
  * Templates: URLs, headers, lookup bodies, identifier, name, metadata and
5729
5889
  * env values are strings with {{path}} placeholders. A path is read from
5730
5890
  * the flow's document, which grows as the flow goes:
@@ -5742,12 +5902,12 @@ export interface AuthSchemeCapability {
5742
5902
  * path present. A template none of whose placeholders resolve renders "":
5743
5903
  * omitted from env and metadata, blank as identifier or name.
5744
5904
  */
5745
- export interface AuthSchemeSpec {
5746
- kind: AuthSchemeKind;
5905
+ export interface AuthMethod {
5906
+ kind: AuthMethodKind;
5747
5907
  /**
5748
5908
  * Flow is the oauth2 grant; empty means authorization_code.
5749
5909
  */
5750
- flow?: AuthSchemeFlow;
5910
+ flow?: AuthMethodFlow;
5751
5911
  /**
5752
5912
  * Fields are what a person pastes (api_key and http kinds).
5753
5913
  */
@@ -5757,13 +5917,13 @@ export interface AuthSchemeSpec {
5757
5917
  * header or query parameter of that name. ValuePrefix is prepended to
5758
5918
  * the value ("Bearer "). Not needed to connect; read by injection.
5759
5919
  */
5760
- in?: AuthSchemeAPIKeyIn;
5920
+ in?: AuthMethodAPIKeyIn;
5761
5921
  param_name?: string;
5762
5922
  value_prefix?: string;
5763
5923
  /**
5764
5924
  * Scheme and BearerFormat describe an http kind's Authorization header.
5765
5925
  */
5766
- scheme?: AuthSchemeHTTPScheme;
5926
+ scheme?: AuthMethodHTTPScheme;
5767
5927
  bearer_format?: string;
5768
5928
  authorization_endpoint?: string;
5769
5929
  scopes?: string[];
@@ -5855,7 +6015,7 @@ export interface AuthSchemeSpec {
5855
6015
  callback?: string;
5856
6016
  /**
5857
6017
  * Profile names the authorization server's deviations from the specs
5858
- * (authprovider.AuthServerProfile: endpoints placed by app fields,
6018
+ * (authmethod.AuthServerProfile: endpoints placed by app fields,
5859
6019
  * scopes on refresh, actionable errors, admin consent). Empty = none.
5860
6020
  */
5861
6021
  profile?: string;
@@ -5866,8 +6026,8 @@ export interface AuthSchemeSpec {
5866
6026
  * with a form POST.
5867
6027
  */
5868
6028
  revocation_endpoint?: string;
5869
- client_auth?: AuthSchemeClientAuth;
5870
- token_request?: AuthSchemeTokenRequest;
6029
+ client_auth?: AuthMethodClientAuth;
6030
+ token_request?: AuthMethodTokenRequest;
5871
6031
  /**
5872
6032
  * Headers go on every request to the provider (User-Agent for Reddit,
5873
6033
  * Notion-Version); values are templates ({{client_id}} for Twitch's
@@ -5881,8 +6041,8 @@ export interface AuthSchemeSpec {
5881
6041
  * not the RFC 6749 shape (Slack's nested authed_user). Empty = standard.
5882
6042
  */
5883
6043
  token_response_hook?: string;
5884
- refresh?: AuthSchemeRefresh;
5885
- revoke?: AuthSchemeRevoke;
6044
+ refresh?: AuthMethodRefresh;
6045
+ revoke?: AuthMethodRevoke;
5886
6046
  /**
5887
6047
  * UserInfoURL is fetched with the new access token; the response is the
5888
6048
  * identity document (user.*). UserInfoURLPath instead reads that URL
@@ -5892,7 +6052,7 @@ export interface AuthSchemeSpec {
5892
6052
  */
5893
6053
  userinfo_url?: string;
5894
6054
  userinfo_url_path?: string;
5895
- lookups?: AuthSchemeLookup[];
6055
+ lookups?: AuthMethodLookup[];
5896
6056
  /**
5897
6057
  * Identifier is the connected account's stable, human-readable id
5898
6058
  * ("{{user.email}}", "@{{user.data.username}}"); Name its display name.
@@ -5929,14 +6089,14 @@ export interface AuthSchemeSpec {
5929
6089
  * AppKeys are the OAuth app's keys beyond the implied client id and
5930
6090
  * secret, and label overrides for those.
5931
6091
  */
5932
- app_keys?: AuthSchemeAppKey[];
6092
+ app_keys?: AuthMethodAppKey[];
5933
6093
  /**
5934
6094
  * VarsHook names Go code that turns the app's extra keys into the
5935
6095
  * {var} values substituted into the URLs (Microsoft's tenant,
5936
6096
  * Salesforce's sandbox host).
5937
6097
  */
5938
6098
  vars_hook?: string;
5939
- capabilities?: AuthSchemeCapability[];
6099
+ capabilities?: AuthMethodCapability[];
5940
6100
  }
5941
6101
  /**
5942
6102
  * Visibility represents the visibility level of a resource
@@ -5954,9 +6114,15 @@ export declare const VisibilityUnlisted: Visibility;
5954
6114
  /**
5955
6115
  * Permission represents a permission level for access checks.
5956
6116
  */
5957
- export type Permission = "read" | "write" | "use";
6117
+ export type Permission = "read" | "write" | "interact" | "use";
5958
6118
  export declare const PermRead: Permission;
5959
6119
  export declare const PermWrite: Permission;
6120
+ /**
6121
+ * PermInteract changes what a page's people keep in it (an artifact's
6122
+ * shared data) without editing the page. Write covers interact, and
6123
+ * interact covers read; public and unlisted visibility grant read only.
6124
+ */
6125
+ export declare const PermInteract: Permission;
5960
6126
  /**
5961
6127
  * PermUse is execute intent: run an app, load a skill/knowledge into an
5962
6128
  * agent context, invoke an MCP tool. Distinct from read — a public
@@ -6627,8 +6793,11 @@ export interface ResponseFormat {
6627
6793
  * assignment.
6628
6794
  * Which model runs is not a setting: the app is the model. An app that
6629
6795
  * fronts several models (a router) declares its own `model` input.
6796
+ * Field order is schema order: the generated pydantic model, and the input
6797
+ * form built from its JSON schema, list fields as they are declared here.
6630
6798
  */
6631
6799
  export interface LLMSettings {
6800
+ system_prompt: string;
6632
6801
  context_size: number;
6633
6802
  temperature?: number;
6634
6803
  top_p?: number;
@@ -6642,23 +6811,24 @@ export interface LLMSettings {
6642
6811
  max_tokens?: number;
6643
6812
  reasoning_effort?: string;
6644
6813
  reasoning_max_tokens?: number;
6645
- system_prompt: string;
6646
6814
  tools?: Tool[];
6647
6815
  tool_choice?: ToolChoice;
6648
6816
  response_format?: ResponseFormat;
6649
6817
  }
6650
6818
  /**
6651
- * LLMInput is the input envelope for an LLM provider task: the settings plus
6652
- * the conversation, with the current turn split out of the context.
6819
+ * LLMInput is the input envelope for an LLM provider task: the conversation,
6820
+ * with the current turn split out of the context, plus the settings.
6821
+ * Field order is schema order (see LLMSettings): the turn comes first, the
6822
+ * settings last, so an input form shows what to say before how to say it.
6653
6823
  */
6654
6824
  export interface LLMInput extends LLMSettings {
6655
- context: LLMContextMessage[];
6656
- role?: ChatMessageRole;
6657
6825
  text?: string;
6658
- reasoning?: string;
6659
- attachments?: FileRef[];
6660
6826
  images?: string[];
6661
6827
  files?: string[];
6828
+ attachments?: FileRef[];
6829
+ context: LLMContextMessage[];
6830
+ role?: ChatMessageRole;
6831
+ reasoning?: string;
6662
6832
  tool_call_id?: string;
6663
6833
  }
6664
6834
  /**
@@ -7768,6 +7938,16 @@ export interface ContextInjection {
7768
7938
  */
7769
7939
  items?: string[];
7770
7940
  }
7941
+ /**
7942
+ * CompactionMeta is stored on ChatMessage for context compaction markers.
7943
+ */
7944
+ export interface CompactionMeta {
7945
+ compacted_up_to_order: number;
7946
+ compacted_count: number;
7947
+ estimated_tokens: number;
7948
+ method?: string;
7949
+ analysis?: string;
7950
+ }
7771
7951
  /**
7772
7952
  * ToolCallEventData is the typed payload for agent.tool_call events.
7773
7953
  */