@onkernel/sdk 0.121.0 → 0.123.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/CHANGELOG.md +21 -0
- package/client.d.mts +4 -4
- package/client.d.mts.map +1 -1
- package/client.d.ts +4 -4
- package/client.d.ts.map +1 -1
- package/client.js.map +1 -1
- package/client.mjs.map +1 -1
- package/package.json +1 -1
- package/resources/browser-pools.d.mts +21 -7
- package/resources/browser-pools.d.mts.map +1 -1
- package/resources/browser-pools.d.ts +21 -7
- package/resources/browser-pools.d.ts.map +1 -1
- package/resources/browsers/browsers.d.mts +62 -28
- package/resources/browsers/browsers.d.mts.map +1 -1
- package/resources/browsers/browsers.d.ts +62 -28
- package/resources/browsers/browsers.d.ts.map +1 -1
- package/resources/browsers/browsers.js.map +1 -1
- package/resources/browsers/browsers.mjs.map +1 -1
- package/resources/browsers/index.d.mts +1 -1
- package/resources/browsers/index.d.mts.map +1 -1
- package/resources/browsers/index.d.ts +1 -1
- package/resources/browsers/index.d.ts.map +1 -1
- package/resources/browsers/index.js.map +1 -1
- package/resources/browsers/index.mjs.map +1 -1
- package/resources/browsers/telemetry.d.mts +94 -33
- package/resources/browsers/telemetry.d.mts.map +1 -1
- package/resources/browsers/telemetry.d.ts +94 -33
- package/resources/browsers/telemetry.d.ts.map +1 -1
- package/resources/browsers/telemetry.js +4 -1
- package/resources/browsers/telemetry.js.map +1 -1
- package/resources/browsers/telemetry.mjs +4 -1
- package/resources/browsers/telemetry.mjs.map +1 -1
- package/resources/config-registry/config-registry.d.mts +2 -2
- package/resources/config-registry/config-registry.d.ts +2 -2
- package/resources/index.d.mts +2 -2
- package/resources/index.d.mts.map +1 -1
- package/resources/index.d.ts +2 -2
- package/resources/index.d.ts.map +1 -1
- package/resources/index.js.map +1 -1
- package/resources/index.mjs.map +1 -1
- package/resources/invocations.d.mts +4 -0
- package/resources/invocations.d.mts.map +1 -1
- package/resources/invocations.d.ts +4 -0
- package/resources/invocations.d.ts.map +1 -1
- package/resources/proxies.d.mts +12 -12
- package/resources/proxies.d.ts +12 -12
- package/resources/vaults/index.d.mts +1 -1
- package/resources/vaults/index.d.mts.map +1 -1
- package/resources/vaults/index.d.ts +1 -1
- package/resources/vaults/index.d.ts.map +1 -1
- package/resources/vaults/index.js.map +1 -1
- package/resources/vaults/index.mjs.map +1 -1
- package/resources/vaults/items.d.mts +61 -19
- package/resources/vaults/items.d.mts.map +1 -1
- package/resources/vaults/items.d.ts +61 -19
- package/resources/vaults/items.d.ts.map +1 -1
- package/resources/vaults/items.js +2 -2
- package/resources/vaults/items.mjs +2 -2
- package/resources/vaults/vaults.d.mts +62 -1
- package/resources/vaults/vaults.d.mts.map +1 -1
- package/resources/vaults/vaults.d.ts +62 -1
- package/resources/vaults/vaults.d.ts.map +1 -1
- package/resources/vaults/vaults.js +19 -0
- package/resources/vaults/vaults.js.map +1 -1
- package/resources/vaults/vaults.mjs +19 -0
- package/resources/vaults/vaults.mjs.map +1 -1
- package/src/client.ts +4 -0
- package/src/resources/browser-pools.ts +22 -7
- package/src/resources/browsers/browsers.ts +68 -27
- package/src/resources/browsers/index.ts +1 -0
- package/src/resources/browsers/telemetry.ts +126 -33
- package/src/resources/config-registry/config-registry.ts +2 -2
- package/src/resources/index.ts +2 -0
- package/src/resources/invocations.ts +5 -0
- package/src/resources/proxies.ts +12 -12
- package/src/resources/vaults/index.ts +1 -0
- package/src/resources/vaults/items.ts +63 -19
- package/src/resources/vaults/vaults.ts +73 -0
- package/src/version.ts +1 -1
- package/version.d.mts +1 -1
- package/version.d.ts +1 -1
- package/version.js +1 -1
- package/version.mjs +1 -1
|
@@ -40,6 +40,23 @@ export declare class Vaults extends APIResource {
|
|
|
40
40
|
* ```
|
|
41
41
|
*/
|
|
42
42
|
delete(idOrName: string, options?: RequestOptions): APIPromise<void>;
|
|
43
|
+
/**
|
|
44
|
+
* Returns the public key that custom credential collection web apps use to encrypt
|
|
45
|
+
* values in the browser. Use this only if you run your own credential collection
|
|
46
|
+
* web app and want values encrypted in the browser, sent to your backend still
|
|
47
|
+
* encrypted, and forwarded to Kernel's API still encrypted. In every other case,
|
|
48
|
+
* including server-side code that already holds the plaintext, use value. The page
|
|
49
|
+
* encrypts each value to this key, your backend forwards the ciphertext unchanged
|
|
50
|
+
* as encrypted_value when creating or updating a credential item in this vault,
|
|
51
|
+
* and Kernel decrypts it.
|
|
52
|
+
*
|
|
53
|
+
* @example
|
|
54
|
+
* ```ts
|
|
55
|
+
* const vaultEncryptionKey =
|
|
56
|
+
* await client.vaults.retrieveEncryptionKey('id_or_name');
|
|
57
|
+
* ```
|
|
58
|
+
*/
|
|
59
|
+
retrieveEncryptionKey(idOrName: string, options?: RequestOptions): APIPromise<VaultEncryptionKey>;
|
|
43
60
|
/**
|
|
44
61
|
* Free organizations can store up to 3 non-deleted vaults across all projects.
|
|
45
62
|
* Paid plans and active trials have no vault cap. Retrieving an existing vault by
|
|
@@ -64,6 +81,50 @@ export interface Vault {
|
|
|
64
81
|
name: string;
|
|
65
82
|
updated_at: string;
|
|
66
83
|
}
|
|
84
|
+
/**
|
|
85
|
+
* Public key for encrypted_value on credential fields. Use this only if you run
|
|
86
|
+
* your own credential collection web app and want values encrypted in the browser,
|
|
87
|
+
* sent to your backend still encrypted, and forwarded to Kernel's API still
|
|
88
|
+
* encrypted. In every other case, including server-side code that already holds
|
|
89
|
+
* the plaintext, use value. Each vault has its own key; a value encrypted for one
|
|
90
|
+
* vault is rejected by every other vault. The key is created on first request and
|
|
91
|
+
* stays the same for the vault's lifetime, so it may be cached.
|
|
92
|
+
*/
|
|
93
|
+
export interface VaultEncryptionKey {
|
|
94
|
+
/**
|
|
95
|
+
* JWE key management algorithm.
|
|
96
|
+
*/
|
|
97
|
+
alg: 'ECDH-ES';
|
|
98
|
+
/**
|
|
99
|
+
* JWE content encryption algorithm.
|
|
100
|
+
*/
|
|
101
|
+
enc: 'A256GCM';
|
|
102
|
+
/**
|
|
103
|
+
* P-256 public key in JWK form.
|
|
104
|
+
*/
|
|
105
|
+
jwk: VaultEncryptionKey.Jwk;
|
|
106
|
+
/**
|
|
107
|
+
* Key ID. Set it as the kid protected header of every encrypted_value.
|
|
108
|
+
*/
|
|
109
|
+
kid: string;
|
|
110
|
+
}
|
|
111
|
+
export declare namespace VaultEncryptionKey {
|
|
112
|
+
/**
|
|
113
|
+
* P-256 public key in JWK form.
|
|
114
|
+
*/
|
|
115
|
+
interface Jwk {
|
|
116
|
+
crv: 'P-256';
|
|
117
|
+
kty: 'EC';
|
|
118
|
+
/**
|
|
119
|
+
* Base64url-encoded x coordinate.
|
|
120
|
+
*/
|
|
121
|
+
x: string;
|
|
122
|
+
/**
|
|
123
|
+
* Base64url-encoded y coordinate.
|
|
124
|
+
*/
|
|
125
|
+
y: string;
|
|
126
|
+
}
|
|
127
|
+
}
|
|
67
128
|
export interface VaultListParams extends OffsetPaginationParams {
|
|
68
129
|
/**
|
|
69
130
|
* Case-insensitive substring match against vault name. IDs match by exact value.
|
|
@@ -77,7 +138,7 @@ export interface VaultUpsertParams {
|
|
|
77
138
|
name: string;
|
|
78
139
|
}
|
|
79
140
|
export declare namespace Vaults {
|
|
80
|
-
export { type Vault as Vault, type VaultsOffsetPagination as VaultsOffsetPagination, type VaultListParams as VaultListParams, type VaultUpsertParams as VaultUpsertParams, };
|
|
141
|
+
export { type Vault as Vault, type VaultEncryptionKey as VaultEncryptionKey, type VaultsOffsetPagination as VaultsOffsetPagination, type VaultListParams as VaultListParams, type VaultUpsertParams as VaultUpsertParams, };
|
|
81
142
|
export { Items as Items, type AgentcardCheckoutAuthorization as AgentcardCheckoutAuthorization, type AgentcardCheckoutPreparation as AgentcardCheckoutPreparation, type AgentcardPreparedProcessor as AgentcardPreparedProcessor, type AuthorizeVaultItemOperationRequest as AuthorizeVaultItemOperationRequest, type CardVaultItemSpec as CardVaultItemSpec, type CardVaultItemState as CardVaultItemState, type CollectVaultItemOperationRequest as CollectVaultItemOperationRequest, type CredentialAccountVaultItem as CredentialAccountVaultItem, type CredentialAccountVaultItemRequest as CredentialAccountVaultItemRequest, type CredentialCollectionAction as CredentialCollectionAction, type CredentialVaultFieldDefinition as CredentialVaultFieldDefinition, type CredentialVaultFieldInput as CredentialVaultFieldInput, type CredentialVaultFieldState as CredentialVaultFieldState, type CredentialVaultFieldType as CredentialVaultFieldType, type CredentialVaultFieldUpdate as CredentialVaultFieldUpdate, type CredentialVaultItem as CredentialVaultItem, type CredentialVaultItemRequest as CredentialVaultItemRequest, type CredentialVaultItemSpec as CredentialVaultItemSpec, type CredentialVaultItemSpecInput as CredentialVaultItemSpecInput, type CredentialVaultItemSpecUpdate as CredentialVaultItemSpecUpdate, type CredentialVaultItemState as CredentialVaultItemState, type CredentialVaultItemUpdateRequest as CredentialVaultItemUpdateRequest, type FillVaultItemOperationRequest as FillVaultItemOperationRequest, type FillVaultItemOperationResult as FillVaultItemOperationResult, type KernelCardState as KernelCardState, type KernelCardVaultItemSpec as KernelCardVaultItemSpec, type KernelCredentialVaultItemSpec as KernelCredentialVaultItemSpec, type KernelCredentialVaultItemSpecInput as KernelCredentialVaultItemSpecInput, type KernelCredentialVaultItemState as KernelCredentialVaultItemState, type KernelWalletState as KernelWalletState, type KernelWalletVaultItemSpec as KernelWalletVaultItemSpec, type ManagedAuthCredentialVaultField as ManagedAuthCredentialVaultField, type ManagedAuthCredentialVaultItemSpec as ManagedAuthCredentialVaultItemSpec, type ManagedAuthCredentialVaultItemSpecInput as ManagedAuthCredentialVaultItemSpecInput, type ManagedAuthCredentialVaultItemState as ManagedAuthCredentialVaultItemState, type OnePasswordCredentialAccountSpec as OnePasswordCredentialAccountSpec, type OnePasswordCredentialAccountState as OnePasswordCredentialAccountState, type OnePasswordCredentialVaultItemSpec as OnePasswordCredentialVaultItemSpec, type OnePasswordCredentialVaultItemSpecInput as OnePasswordCredentialVaultItemSpecInput, type OnePasswordCredentialVaultItemState as OnePasswordCredentialVaultItemState, type OnePasswordFillVaultItemOperationRequest as OnePasswordFillVaultItemOperationRequest, type OnePasswordFillVaultItemOperationResult as OnePasswordFillVaultItemOperationResult, type OnePasswordOAuthAction as OnePasswordOAuthAction, type OnePasswordRecoverVaultItemOperationRequest as OnePasswordRecoverVaultItemOperationRequest, type OnePasswordRequestAccessVaultItemOperationRequest as OnePasswordRequestAccessVaultItemOperationRequest, type PrepareCheckoutVaultItemOperationRequest as PrepareCheckoutVaultItemOperationRequest, type VaultCardAliases as VaultCardAliases, type VaultCardFillField as VaultCardFillField, type VaultCheckoutContext as VaultCheckoutContext, type VaultFillField as VaultFillField, type VaultFillFieldResult as VaultFillFieldResult, type VaultItem as VaultItem, type VaultItemAction as VaultItemAction, type VaultItemEvent as VaultItemEvent, type VaultItemOperationResponse as VaultItemOperationResponse, type VaultPaymentMethod as VaultPaymentMethod, type VaultWebmcpBinding as VaultWebmcpBinding, type WalletVaultItemSpec as WalletVaultItemSpec, type WalletVaultItemState as WalletVaultItemState, type WebmcpInvokeVaultItemOperationRequest as WebmcpInvokeVaultItemOperationRequest, type WebmcpInvokeVaultItemOperationResult as WebmcpInvokeVaultItemOperationResult, type ItemListResponse as ItemListResponse, type ItemEventsResponse as ItemEventsResponse, type ItemRetrieveParams as ItemRetrieveParams, type ItemUpdateParams as ItemUpdateParams, type ItemDeleteParams as ItemDeleteParams, type ItemEventsParams as ItemEventsParams, type ItemPerformOperationParams as ItemPerformOperationParams, type ItemUpsertParams as ItemUpsertParams, };
|
|
82
143
|
}
|
|
83
144
|
//# sourceMappingURL=vaults.d.ts.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"vaults.d.ts","sourceRoot":"","sources":["../../src/resources/vaults/vaults.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAE,+BAA4B;AAClD,OAAO,KAAK,QAAQ,mBAAgB;AACpC,OAAO,EACL,8BAA8B,EAC9B,4BAA4B,EAC5B,0BAA0B,EAC1B,kCAAkC,EAClC,iBAAiB,EACjB,kBAAkB,EAClB,gCAAgC,EAChC,0BAA0B,EAC1B,iCAAiC,EACjC,0BAA0B,EAC1B,8BAA8B,EAC9B,yBAAyB,EACzB,yBAAyB,EACzB,wBAAwB,EACxB,0BAA0B,EAC1B,mBAAmB,EACnB,0BAA0B,EAC1B,uBAAuB,EACvB,4BAA4B,EAC5B,6BAA6B,EAC7B,wBAAwB,EACxB,gCAAgC,EAChC,6BAA6B,EAC7B,4BAA4B,EAC5B,gBAAgB,EAChB,gBAAgB,EAChB,kBAAkB,EAClB,gBAAgB,EAChB,0BAA0B,EAC1B,kBAAkB,EAClB,gBAAgB,EAChB,gBAAgB,EAChB,KAAK,EACL,eAAe,EACf,uBAAuB,EACvB,6BAA6B,EAC7B,kCAAkC,EAClC,8BAA8B,EAC9B,iBAAiB,EACjB,yBAAyB,EACzB,+BAA+B,EAC/B,kCAAkC,EAClC,uCAAuC,EACvC,mCAAmC,EACnC,gCAAgC,EAChC,iCAAiC,EACjC,kCAAkC,EAClC,uCAAuC,EACvC,mCAAmC,EACnC,wCAAwC,EACxC,uCAAuC,EACvC,sBAAsB,EACtB,2CAA2C,EAC3C,iDAAiD,EACjD,wCAAwC,EACxC,gBAAgB,EAChB,kBAAkB,EAClB,oBAAoB,EACpB,cAAc,EACd,oBAAoB,EACpB,SAAS,EACT,eAAe,EACf,cAAc,EACd,0BAA0B,EAC1B,kBAAkB,EAClB,kBAAkB,EAClB,mBAAmB,EACnB,oBAAoB,EACpB,qCAAqC,EACrC,oCAAoC,EACrC,mBAAgB;AACjB,OAAO,EAAE,UAAU,EAAE,kCAA+B;AACpD,OAAO,EAAE,gBAAgB,EAAE,KAAK,sBAAsB,EAAE,WAAW,EAAE,iCAA8B;AAEnG,OAAO,EAAE,cAAc,EAAE,0CAAuC;AAGhE,qBAAa,MAAO,SAAQ,WAAW;IACrC,KAAK,EAAE,QAAQ,CAAC,KAAK,CAAoC;IAEzD;;;;;;;OAOG;IACH,QAAQ,CAAC,QAAQ,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,KAAK,CAAC;IAIvE;;;;;;;;;;OAUG;IACH,IAAI,CACF,KAAK,GAAE,eAAe,GAAG,IAAI,GAAG,SAAc,EAC9C,OAAO,CAAC,EAAE,cAAc,GACvB,WAAW,CAAC,sBAAsB,EAAE,KAAK,CAAC;IAI7C;;;;;;;;;;;OAWG;IACH,MAAM,CAAC,QAAQ,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,IAAI,CAAC;IAOpE;;;;;;;;;;;OAWG;IACH,MAAM,CAAC,IAAI,EAAE,iBAAiB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,KAAK,CAAC;CAG7E;AAED,MAAM,MAAM,sBAAsB,GAAG,gBAAgB,CAAC,KAAK,CAAC,CAAC;AAE7D,MAAM,WAAW,KAAK;IACpB,EAAE,EAAE,MAAM,CAAC;IAEX,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb,UAAU,EAAE,MAAM,CAAC;CACpB;AAED,MAAM,WAAW,eAAgB,SAAQ,sBAAsB;IAC7D;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;CAChB;AAED,MAAM,WAAW,iBAAiB;IAChC;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;CACd;AAID,MAAM,CAAC,OAAO,WAAW,MAAM,CAAC;IAC9B,OAAO,EACL,KAAK,KAAK,IAAI,KAAK,EACnB,KAAK,sBAAsB,IAAI,sBAAsB,EACrD,KAAK,eAAe,IAAI,eAAe,EACvC,KAAK,iBAAiB,IAAI,iBAAiB,GAC5C,CAAC;IAEF,OAAO,EACL,KAAK,IAAI,KAAK,EACd,KAAK,8BAA8B,IAAI,8BAA8B,EACrE,KAAK,4BAA4B,IAAI,4BAA4B,EACjE,KAAK,0BAA0B,IAAI,0BAA0B,EAC7D,KAAK,kCAAkC,IAAI,kCAAkC,EAC7E,KAAK,iBAAiB,IAAI,iBAAiB,EAC3C,KAAK,kBAAkB,IAAI,kBAAkB,EAC7C,KAAK,gCAAgC,IAAI,gCAAgC,EACzE,KAAK,0BAA0B,IAAI,0BAA0B,EAC7D,KAAK,iCAAiC,IAAI,iCAAiC,EAC3E,KAAK,0BAA0B,IAAI,0BAA0B,EAC7D,KAAK,8BAA8B,IAAI,8BAA8B,EACrE,KAAK,yBAAyB,IAAI,yBAAyB,EAC3D,KAAK,yBAAyB,IAAI,yBAAyB,EAC3D,KAAK,wBAAwB,IAAI,wBAAwB,EACzD,KAAK,0BAA0B,IAAI,0BAA0B,EAC7D,KAAK,mBAAmB,IAAI,mBAAmB,EAC/C,KAAK,0BAA0B,IAAI,0BAA0B,EAC7D,KAAK,uBAAuB,IAAI,uBAAuB,EACvD,KAAK,4BAA4B,IAAI,4BAA4B,EACjE,KAAK,6BAA6B,IAAI,6BAA6B,EACnE,KAAK,wBAAwB,IAAI,wBAAwB,EACzD,KAAK,gCAAgC,IAAI,gCAAgC,EACzE,KAAK,6BAA6B,IAAI,6BAA6B,EACnE,KAAK,4BAA4B,IAAI,4BAA4B,EACjE,KAAK,eAAe,IAAI,eAAe,EACvC,KAAK,uBAAuB,IAAI,uBAAuB,EACvD,KAAK,6BAA6B,IAAI,6BAA6B,EACnE,KAAK,kCAAkC,IAAI,kCAAkC,EAC7E,KAAK,8BAA8B,IAAI,8BAA8B,EACrE,KAAK,iBAAiB,IAAI,iBAAiB,EAC3C,KAAK,yBAAyB,IAAI,yBAAyB,EAC3D,KAAK,+BAA+B,IAAI,+BAA+B,EACvE,KAAK,kCAAkC,IAAI,kCAAkC,EAC7E,KAAK,uCAAuC,IAAI,uCAAuC,EACvF,KAAK,mCAAmC,IAAI,mCAAmC,EAC/E,KAAK,gCAAgC,IAAI,gCAAgC,EACzE,KAAK,iCAAiC,IAAI,iCAAiC,EAC3E,KAAK,kCAAkC,IAAI,kCAAkC,EAC7E,KAAK,uCAAuC,IAAI,uCAAuC,EACvF,KAAK,mCAAmC,IAAI,mCAAmC,EAC/E,KAAK,wCAAwC,IAAI,wCAAwC,EACzF,KAAK,uCAAuC,IAAI,uCAAuC,EACvF,KAAK,sBAAsB,IAAI,sBAAsB,EACrD,KAAK,2CAA2C,IAAI,2CAA2C,EAC/F,KAAK,iDAAiD,IAAI,iDAAiD,EAC3G,KAAK,wCAAwC,IAAI,wCAAwC,EACzF,KAAK,gBAAgB,IAAI,gBAAgB,EACzC,KAAK,kBAAkB,IAAI,kBAAkB,EAC7C,KAAK,oBAAoB,IAAI,oBAAoB,EACjD,KAAK,cAAc,IAAI,cAAc,EACrC,KAAK,oBAAoB,IAAI,oBAAoB,EACjD,KAAK,SAAS,IAAI,SAAS,EAC3B,KAAK,eAAe,IAAI,eAAe,EACvC,KAAK,cAAc,IAAI,cAAc,EACrC,KAAK,0BAA0B,IAAI,0BAA0B,EAC7D,KAAK,kBAAkB,IAAI,kBAAkB,EAC7C,KAAK,kBAAkB,IAAI,kBAAkB,EAC7C,KAAK,mBAAmB,IAAI,mBAAmB,EAC/C,KAAK,oBAAoB,IAAI,oBAAoB,EACjD,KAAK,qCAAqC,IAAI,qCAAqC,EACnF,KAAK,oCAAoC,IAAI,oCAAoC,EACjF,KAAK,gBAAgB,IAAI,gBAAgB,EACzC,KAAK,kBAAkB,IAAI,kBAAkB,EAC7C,KAAK,kBAAkB,IAAI,kBAAkB,EAC7C,KAAK,gBAAgB,IAAI,gBAAgB,EACzC,KAAK,gBAAgB,IAAI,gBAAgB,EACzC,KAAK,gBAAgB,IAAI,gBAAgB,EACzC,KAAK,0BAA0B,IAAI,0BAA0B,EAC7D,KAAK,gBAAgB,IAAI,gBAAgB,GAC1C,CAAC;CACH"}
|
|
1
|
+
{"version":3,"file":"vaults.d.ts","sourceRoot":"","sources":["../../src/resources/vaults/vaults.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAE,+BAA4B;AAClD,OAAO,KAAK,QAAQ,mBAAgB;AACpC,OAAO,EACL,8BAA8B,EAC9B,4BAA4B,EAC5B,0BAA0B,EAC1B,kCAAkC,EAClC,iBAAiB,EACjB,kBAAkB,EAClB,gCAAgC,EAChC,0BAA0B,EAC1B,iCAAiC,EACjC,0BAA0B,EAC1B,8BAA8B,EAC9B,yBAAyB,EACzB,yBAAyB,EACzB,wBAAwB,EACxB,0BAA0B,EAC1B,mBAAmB,EACnB,0BAA0B,EAC1B,uBAAuB,EACvB,4BAA4B,EAC5B,6BAA6B,EAC7B,wBAAwB,EACxB,gCAAgC,EAChC,6BAA6B,EAC7B,4BAA4B,EAC5B,gBAAgB,EAChB,gBAAgB,EAChB,kBAAkB,EAClB,gBAAgB,EAChB,0BAA0B,EAC1B,kBAAkB,EAClB,gBAAgB,EAChB,gBAAgB,EAChB,KAAK,EACL,eAAe,EACf,uBAAuB,EACvB,6BAA6B,EAC7B,kCAAkC,EAClC,8BAA8B,EAC9B,iBAAiB,EACjB,yBAAyB,EACzB,+BAA+B,EAC/B,kCAAkC,EAClC,uCAAuC,EACvC,mCAAmC,EACnC,gCAAgC,EAChC,iCAAiC,EACjC,kCAAkC,EAClC,uCAAuC,EACvC,mCAAmC,EACnC,wCAAwC,EACxC,uCAAuC,EACvC,sBAAsB,EACtB,2CAA2C,EAC3C,iDAAiD,EACjD,wCAAwC,EACxC,gBAAgB,EAChB,kBAAkB,EAClB,oBAAoB,EACpB,cAAc,EACd,oBAAoB,EACpB,SAAS,EACT,eAAe,EACf,cAAc,EACd,0BAA0B,EAC1B,kBAAkB,EAClB,kBAAkB,EAClB,mBAAmB,EACnB,oBAAoB,EACpB,qCAAqC,EACrC,oCAAoC,EACrC,mBAAgB;AACjB,OAAO,EAAE,UAAU,EAAE,kCAA+B;AACpD,OAAO,EAAE,gBAAgB,EAAE,KAAK,sBAAsB,EAAE,WAAW,EAAE,iCAA8B;AAEnG,OAAO,EAAE,cAAc,EAAE,0CAAuC;AAGhE,qBAAa,MAAO,SAAQ,WAAW;IACrC,KAAK,EAAE,QAAQ,CAAC,KAAK,CAAoC;IAEzD;;;;;;;OAOG;IACH,QAAQ,CAAC,QAAQ,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,KAAK,CAAC;IAIvE;;;;;;;;;;OAUG;IACH,IAAI,CACF,KAAK,GAAE,eAAe,GAAG,IAAI,GAAG,SAAc,EAC9C,OAAO,CAAC,EAAE,cAAc,GACvB,WAAW,CAAC,sBAAsB,EAAE,KAAK,CAAC;IAI7C;;;;;;;;;;;OAWG;IACH,MAAM,CAAC,QAAQ,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,IAAI,CAAC;IAOpE;;;;;;;;;;;;;;;OAeG;IACH,qBAAqB,CAAC,QAAQ,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,kBAAkB,CAAC;IAIjG;;;;;;;;;;;OAWG;IACH,MAAM,CAAC,IAAI,EAAE,iBAAiB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,KAAK,CAAC;CAG7E;AAED,MAAM,MAAM,sBAAsB,GAAG,gBAAgB,CAAC,KAAK,CAAC,CAAC;AAE7D,MAAM,WAAW,KAAK;IACpB,EAAE,EAAE,MAAM,CAAC;IAEX,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb,UAAU,EAAE,MAAM,CAAC;CACpB;AAED;;;;;;;;GAQG;AACH,MAAM,WAAW,kBAAkB;IACjC;;OAEG;IACH,GAAG,EAAE,SAAS,CAAC;IAEf;;OAEG;IACH,GAAG,EAAE,SAAS,CAAC;IAEf;;OAEG;IACH,GAAG,EAAE,kBAAkB,CAAC,GAAG,CAAC;IAE5B;;OAEG;IACH,GAAG,EAAE,MAAM,CAAC;CACb;AAED,yBAAiB,kBAAkB,CAAC;IAClC;;OAEG;IACH,UAAiB,GAAG;QAClB,GAAG,EAAE,OAAO,CAAC;QAEb,GAAG,EAAE,IAAI,CAAC;QAEV;;WAEG;QACH,CAAC,EAAE,MAAM,CAAC;QAEV;;WAEG;QACH,CAAC,EAAE,MAAM,CAAC;KACX;CACF;AAED,MAAM,WAAW,eAAgB,SAAQ,sBAAsB;IAC7D;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;CAChB;AAED,MAAM,WAAW,iBAAiB;IAChC;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;CACd;AAID,MAAM,CAAC,OAAO,WAAW,MAAM,CAAC;IAC9B,OAAO,EACL,KAAK,KAAK,IAAI,KAAK,EACnB,KAAK,kBAAkB,IAAI,kBAAkB,EAC7C,KAAK,sBAAsB,IAAI,sBAAsB,EACrD,KAAK,eAAe,IAAI,eAAe,EACvC,KAAK,iBAAiB,IAAI,iBAAiB,GAC5C,CAAC;IAEF,OAAO,EACL,KAAK,IAAI,KAAK,EACd,KAAK,8BAA8B,IAAI,8BAA8B,EACrE,KAAK,4BAA4B,IAAI,4BAA4B,EACjE,KAAK,0BAA0B,IAAI,0BAA0B,EAC7D,KAAK,kCAAkC,IAAI,kCAAkC,EAC7E,KAAK,iBAAiB,IAAI,iBAAiB,EAC3C,KAAK,kBAAkB,IAAI,kBAAkB,EAC7C,KAAK,gCAAgC,IAAI,gCAAgC,EACzE,KAAK,0BAA0B,IAAI,0BAA0B,EAC7D,KAAK,iCAAiC,IAAI,iCAAiC,EAC3E,KAAK,0BAA0B,IAAI,0BAA0B,EAC7D,KAAK,8BAA8B,IAAI,8BAA8B,EACrE,KAAK,yBAAyB,IAAI,yBAAyB,EAC3D,KAAK,yBAAyB,IAAI,yBAAyB,EAC3D,KAAK,wBAAwB,IAAI,wBAAwB,EACzD,KAAK,0BAA0B,IAAI,0BAA0B,EAC7D,KAAK,mBAAmB,IAAI,mBAAmB,EAC/C,KAAK,0BAA0B,IAAI,0BAA0B,EAC7D,KAAK,uBAAuB,IAAI,uBAAuB,EACvD,KAAK,4BAA4B,IAAI,4BAA4B,EACjE,KAAK,6BAA6B,IAAI,6BAA6B,EACnE,KAAK,wBAAwB,IAAI,wBAAwB,EACzD,KAAK,gCAAgC,IAAI,gCAAgC,EACzE,KAAK,6BAA6B,IAAI,6BAA6B,EACnE,KAAK,4BAA4B,IAAI,4BAA4B,EACjE,KAAK,eAAe,IAAI,eAAe,EACvC,KAAK,uBAAuB,IAAI,uBAAuB,EACvD,KAAK,6BAA6B,IAAI,6BAA6B,EACnE,KAAK,kCAAkC,IAAI,kCAAkC,EAC7E,KAAK,8BAA8B,IAAI,8BAA8B,EACrE,KAAK,iBAAiB,IAAI,iBAAiB,EAC3C,KAAK,yBAAyB,IAAI,yBAAyB,EAC3D,KAAK,+BAA+B,IAAI,+BAA+B,EACvE,KAAK,kCAAkC,IAAI,kCAAkC,EAC7E,KAAK,uCAAuC,IAAI,uCAAuC,EACvF,KAAK,mCAAmC,IAAI,mCAAmC,EAC/E,KAAK,gCAAgC,IAAI,gCAAgC,EACzE,KAAK,iCAAiC,IAAI,iCAAiC,EAC3E,KAAK,kCAAkC,IAAI,kCAAkC,EAC7E,KAAK,uCAAuC,IAAI,uCAAuC,EACvF,KAAK,mCAAmC,IAAI,mCAAmC,EAC/E,KAAK,wCAAwC,IAAI,wCAAwC,EACzF,KAAK,uCAAuC,IAAI,uCAAuC,EACvF,KAAK,sBAAsB,IAAI,sBAAsB,EACrD,KAAK,2CAA2C,IAAI,2CAA2C,EAC/F,KAAK,iDAAiD,IAAI,iDAAiD,EAC3G,KAAK,wCAAwC,IAAI,wCAAwC,EACzF,KAAK,gBAAgB,IAAI,gBAAgB,EACzC,KAAK,kBAAkB,IAAI,kBAAkB,EAC7C,KAAK,oBAAoB,IAAI,oBAAoB,EACjD,KAAK,cAAc,IAAI,cAAc,EACrC,KAAK,oBAAoB,IAAI,oBAAoB,EACjD,KAAK,SAAS,IAAI,SAAS,EAC3B,KAAK,eAAe,IAAI,eAAe,EACvC,KAAK,cAAc,IAAI,cAAc,EACrC,KAAK,0BAA0B,IAAI,0BAA0B,EAC7D,KAAK,kBAAkB,IAAI,kBAAkB,EAC7C,KAAK,kBAAkB,IAAI,kBAAkB,EAC7C,KAAK,mBAAmB,IAAI,mBAAmB,EAC/C,KAAK,oBAAoB,IAAI,oBAAoB,EACjD,KAAK,qCAAqC,IAAI,qCAAqC,EACnF,KAAK,oCAAoC,IAAI,oCAAoC,EACjF,KAAK,gBAAgB,IAAI,gBAAgB,EACzC,KAAK,kBAAkB,IAAI,kBAAkB,EAC7C,KAAK,kBAAkB,IAAI,kBAAkB,EAC7C,KAAK,gBAAgB,IAAI,gBAAgB,EACzC,KAAK,gBAAgB,IAAI,gBAAgB,EACzC,KAAK,gBAAgB,IAAI,gBAAgB,EACzC,KAAK,0BAA0B,IAAI,0BAA0B,EAC7D,KAAK,gBAAgB,IAAI,gBAAgB,GAC1C,CAAC;CACH"}
|
|
@@ -57,6 +57,25 @@ class Vaults extends resource_1.APIResource {
|
|
|
57
57
|
headers: (0, headers_1.buildHeaders)([{ Accept: '*/*' }, options?.headers]),
|
|
58
58
|
});
|
|
59
59
|
}
|
|
60
|
+
/**
|
|
61
|
+
* Returns the public key that custom credential collection web apps use to encrypt
|
|
62
|
+
* values in the browser. Use this only if you run your own credential collection
|
|
63
|
+
* web app and want values encrypted in the browser, sent to your backend still
|
|
64
|
+
* encrypted, and forwarded to Kernel's API still encrypted. In every other case,
|
|
65
|
+
* including server-side code that already holds the plaintext, use value. The page
|
|
66
|
+
* encrypts each value to this key, your backend forwards the ciphertext unchanged
|
|
67
|
+
* as encrypted_value when creating or updating a credential item in this vault,
|
|
68
|
+
* and Kernel decrypts it.
|
|
69
|
+
*
|
|
70
|
+
* @example
|
|
71
|
+
* ```ts
|
|
72
|
+
* const vaultEncryptionKey =
|
|
73
|
+
* await client.vaults.retrieveEncryptionKey('id_or_name');
|
|
74
|
+
* ```
|
|
75
|
+
*/
|
|
76
|
+
retrieveEncryptionKey(idOrName, options) {
|
|
77
|
+
return this._client.get((0, path_1.path) `/vaults/${idOrName}/encryption_key`, options);
|
|
78
|
+
}
|
|
60
79
|
/**
|
|
61
80
|
* Free organizations can store up to 3 non-deleted vaults across all projects.
|
|
62
81
|
* Paid plans and active trials have no vault cap. Retrieving an existing vault by
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"vaults.js","sourceRoot":"","sources":["../../src/resources/vaults/vaults.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;;AAEtF,qDAAkD;AAClD,6DAAoC;AACpC,sCAuEiB;AAEjB,yDAAmG;AACnG,uDAAsD;AAEtD,uDAAiD;AAEjD,MAAa,MAAO,SAAQ,sBAAW;IAAvC;;QACE,UAAK,GAAmB,IAAI,QAAQ,CAAC,KAAK,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;
|
|
1
|
+
{"version":3,"file":"vaults.js","sourceRoot":"","sources":["../../src/resources/vaults/vaults.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;;AAEtF,qDAAkD;AAClD,6DAAoC;AACpC,sCAuEiB;AAEjB,yDAAmG;AACnG,uDAAsD;AAEtD,uDAAiD;AAEjD,MAAa,MAAO,SAAQ,sBAAW;IAAvC;;QACE,UAAK,GAAmB,IAAI,QAAQ,CAAC,KAAK,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;IAsF3D,CAAC;IApFC;;;;;;;OAOG;IACH,QAAQ,CAAC,QAAgB,EAAE,OAAwB;QACjD,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAA,WAAI,EAAA,WAAW,QAAQ,EAAE,EAAE,OAAO,CAAC,CAAC;IAC9D,CAAC;IAED;;;;;;;;;;OAUG;IACH,IAAI,CACF,QAA4C,EAAE,EAC9C,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,SAAS,EAAE,CAAA,6BAAuB,CAAA,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC5F,CAAC;IAED;;;;;;;;;;;OAWG;IACH,MAAM,CAAC,QAAgB,EAAE,OAAwB;QAC/C,OAAO,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,IAAA,WAAI,EAAA,WAAW,QAAQ,EAAE,EAAE;YACpD,GAAG,OAAO;YACV,OAAO,EAAE,IAAA,sBAAY,EAAC,CAAC,EAAE,MAAM,EAAE,KAAK,EAAE,EAAE,OAAO,EAAE,OAAO,CAAC,CAAC;SAC7D,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;;;;;;OAeG;IACH,qBAAqB,CAAC,QAAgB,EAAE,OAAwB;QAC9D,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAA,WAAI,EAAA,WAAW,QAAQ,iBAAiB,EAAE,OAAO,CAAC,CAAC;IAC7E,CAAC;IAED;;;;;;;;;;;OAWG;IACH,MAAM,CAAC,IAAuB,EAAE,OAAwB;QACtD,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,SAAS,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC5D,CAAC;CACF;AAvFD,wBAuFC;AAmFD,MAAM,CAAC,KAAK,GAAG,aAAK,CAAC"}
|
|
@@ -53,6 +53,25 @@ export class Vaults extends APIResource {
|
|
|
53
53
|
headers: buildHeaders([{ Accept: '*/*' }, options?.headers]),
|
|
54
54
|
});
|
|
55
55
|
}
|
|
56
|
+
/**
|
|
57
|
+
* Returns the public key that custom credential collection web apps use to encrypt
|
|
58
|
+
* values in the browser. Use this only if you run your own credential collection
|
|
59
|
+
* web app and want values encrypted in the browser, sent to your backend still
|
|
60
|
+
* encrypted, and forwarded to Kernel's API still encrypted. In every other case,
|
|
61
|
+
* including server-side code that already holds the plaintext, use value. The page
|
|
62
|
+
* encrypts each value to this key, your backend forwards the ciphertext unchanged
|
|
63
|
+
* as encrypted_value when creating or updating a credential item in this vault,
|
|
64
|
+
* and Kernel decrypts it.
|
|
65
|
+
*
|
|
66
|
+
* @example
|
|
67
|
+
* ```ts
|
|
68
|
+
* const vaultEncryptionKey =
|
|
69
|
+
* await client.vaults.retrieveEncryptionKey('id_or_name');
|
|
70
|
+
* ```
|
|
71
|
+
*/
|
|
72
|
+
retrieveEncryptionKey(idOrName, options) {
|
|
73
|
+
return this._client.get(path `/vaults/${idOrName}/encryption_key`, options);
|
|
74
|
+
}
|
|
56
75
|
/**
|
|
57
76
|
* Free organizations can store up to 3 non-deleted vaults across all projects.
|
|
58
77
|
* Paid plans and active trials have no vault cap. Retrieving an existing vault by
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"vaults.mjs","sourceRoot":"","sources":["../../src/resources/vaults/vaults.ts"],"names":[],"mappings":"AAAA,sFAAsF;AAEtF,OAAO,EAAE,WAAW,EAAE,gCAA4B;AAClD,OAAO,KAAK,QAAQ,oBAAgB;AACpC,OAAO,EAiCL,KAAK,GAsCN,oBAAgB;AAEjB,OAAO,EAAE,gBAAgB,EAA4C,kCAA8B;AACnG,OAAO,EAAE,YAAY,EAAE,mCAA+B;AAEtD,OAAO,EAAE,IAAI,EAAE,sCAAkC;AAEjD,MAAM,OAAO,MAAO,SAAQ,WAAW;IAAvC;;QACE,UAAK,GAAmB,IAAI,QAAQ,CAAC,KAAK,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;
|
|
1
|
+
{"version":3,"file":"vaults.mjs","sourceRoot":"","sources":["../../src/resources/vaults/vaults.ts"],"names":[],"mappings":"AAAA,sFAAsF;AAEtF,OAAO,EAAE,WAAW,EAAE,gCAA4B;AAClD,OAAO,KAAK,QAAQ,oBAAgB;AACpC,OAAO,EAiCL,KAAK,GAsCN,oBAAgB;AAEjB,OAAO,EAAE,gBAAgB,EAA4C,kCAA8B;AACnG,OAAO,EAAE,YAAY,EAAE,mCAA+B;AAEtD,OAAO,EAAE,IAAI,EAAE,sCAAkC;AAEjD,MAAM,OAAO,MAAO,SAAQ,WAAW;IAAvC;;QACE,UAAK,GAAmB,IAAI,QAAQ,CAAC,KAAK,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;IAsF3D,CAAC;IApFC;;;;;;;OAOG;IACH,QAAQ,CAAC,QAAgB,EAAE,OAAwB;QACjD,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAA,WAAW,QAAQ,EAAE,EAAE,OAAO,CAAC,CAAC;IAC9D,CAAC;IAED;;;;;;;;;;OAUG;IACH,IAAI,CACF,QAA4C,EAAE,EAC9C,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,SAAS,EAAE,CAAA,gBAAuB,CAAA,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC5F,CAAC;IAED;;;;;;;;;;;OAWG;IACH,MAAM,CAAC,QAAgB,EAAE,OAAwB;QAC/C,OAAO,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,IAAI,CAAA,WAAW,QAAQ,EAAE,EAAE;YACpD,GAAG,OAAO;YACV,OAAO,EAAE,YAAY,CAAC,CAAC,EAAE,MAAM,EAAE,KAAK,EAAE,EAAE,OAAO,EAAE,OAAO,CAAC,CAAC;SAC7D,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;;;;;;OAeG;IACH,qBAAqB,CAAC,QAAgB,EAAE,OAAwB;QAC9D,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAA,WAAW,QAAQ,iBAAiB,EAAE,OAAO,CAAC,CAAC;IAC7E,CAAC;IAED;;;;;;;;;;;OAWG;IACH,MAAM,CAAC,IAAuB,EAAE,OAAwB;QACtD,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,SAAS,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC5D,CAAC;CACF;AAmFD,MAAM,CAAC,KAAK,GAAG,KAAK,CAAC"}
|
package/src/client.ts
CHANGED
|
@@ -180,6 +180,7 @@ import {
|
|
|
180
180
|
BrowserUpdateParams,
|
|
181
181
|
BrowserUpdateResponse,
|
|
182
182
|
BrowserUsage,
|
|
183
|
+
BrowserVideoMemory,
|
|
183
184
|
Browsers,
|
|
184
185
|
Profile,
|
|
185
186
|
Tags,
|
|
@@ -232,6 +233,7 @@ import {
|
|
|
232
233
|
import { Telemetry } from './resources/telemetry/telemetry';
|
|
233
234
|
import {
|
|
234
235
|
Vault,
|
|
236
|
+
VaultEncryptionKey,
|
|
235
237
|
VaultListParams,
|
|
236
238
|
VaultUpsertParams,
|
|
237
239
|
Vaults,
|
|
@@ -1233,6 +1235,7 @@ export declare namespace Kernel {
|
|
|
1233
1235
|
type BrowserReplResult as BrowserReplResult,
|
|
1234
1236
|
type BrowserReplTextContent as BrowserReplTextContent,
|
|
1235
1237
|
type BrowserUsage as BrowserUsage,
|
|
1238
|
+
type BrowserVideoMemory as BrowserVideoMemory,
|
|
1236
1239
|
type Profile as Profile,
|
|
1237
1240
|
type Tags as Tags,
|
|
1238
1241
|
type VaultReference as VaultReference,
|
|
@@ -1313,6 +1316,7 @@ export declare namespace Kernel {
|
|
|
1313
1316
|
export {
|
|
1314
1317
|
Vaults as Vaults,
|
|
1315
1318
|
type Vault as Vault,
|
|
1319
|
+
type VaultEncryptionKey as VaultEncryptionKey,
|
|
1316
1320
|
type VaultsOffsetPagination as VaultsOffsetPagination,
|
|
1317
1321
|
type VaultListParams as VaultListParams,
|
|
1318
1322
|
type VaultUpsertParams as VaultUpsertParams,
|
|
@@ -517,6 +517,11 @@ export interface BrowserPoolAcquireResponse {
|
|
|
517
517
|
*/
|
|
518
518
|
vaults?: Array<BrowsersAPI.VaultReference>;
|
|
519
519
|
|
|
520
|
+
/**
|
|
521
|
+
* Video memory (VRAM) of the GPU browser session. Only present when gpu is true.
|
|
522
|
+
*/
|
|
523
|
+
video_memory?: BrowsersAPI.BrowserVideoMemory;
|
|
524
|
+
|
|
520
525
|
/**
|
|
521
526
|
* Initial browser window size in pixels with optional refresh rate. If omitted,
|
|
522
527
|
* image defaults apply (1920x1080@25). For GPU images, the default is
|
|
@@ -585,7 +590,9 @@ export interface BrowserPoolCreateParams {
|
|
|
585
590
|
name?: string;
|
|
586
591
|
|
|
587
592
|
/**
|
|
588
|
-
* Network configuration applied to browsers in this pool.
|
|
593
|
+
* Network configuration applied to browsers in this pool. Egress allowlists and
|
|
594
|
+
* proxy routes require proxy-v3; the pool will not provision browsers through
|
|
595
|
+
* Envoy if proxy-v3 is unavailable.
|
|
589
596
|
*/
|
|
590
597
|
network?: BrowsersAPI.BrowserNetworkConfig;
|
|
591
598
|
|
|
@@ -812,9 +819,11 @@ export interface BrowserPoolUpdateParams {
|
|
|
812
819
|
* Whether to discard all idle browsers and rebuild them immediately with the new
|
|
813
820
|
* configuration. Defaults to false. Only browsers that are idle when the update
|
|
814
821
|
* runs are rebuilt. A browser that is in use during the update keeps its original
|
|
815
|
-
* configuration,
|
|
816
|
-
*
|
|
817
|
-
* later
|
|
822
|
+
* configuration, except that its allowlist is reset to the current pool baseline
|
|
823
|
+
* on release or the browser is replaced. For other configuration fields, if it is
|
|
824
|
+
* later released with `reuse: true` it returns to the pool with that stale
|
|
825
|
+
* configuration until it is discarded (by this flag on a later update, or by
|
|
826
|
+
* flushing the pool).
|
|
818
827
|
*/
|
|
819
828
|
discard_all_idle?: boolean;
|
|
820
829
|
|
|
@@ -857,9 +866,15 @@ export interface BrowserPoolUpdateParams {
|
|
|
857
866
|
/**
|
|
858
867
|
* If provided, replaces the pool's network configuration. Omit to leave the
|
|
859
868
|
* existing configuration unchanged; an empty object ({}) removes it, while
|
|
860
|
-
* network: {private_hosts: []}
|
|
861
|
-
*
|
|
862
|
-
*
|
|
869
|
+
* network: {private_hosts: []} or network: {proxy_routes: []} sets an explicit
|
|
870
|
+
* empty list; allowed_hosts must be non-empty when supplied. Egress allowlists and
|
|
871
|
+
* proxy routes require proxy-v3; the pool will not provision browsers through
|
|
872
|
+
* Envoy if proxy-v3 is unavailable. Changing allowed_hosts automatically replaces
|
|
873
|
+
* idle browsers. Leased browsers retain their allowlist until release, when it is
|
|
874
|
+
* reset to the current pool baseline or the browser is replaced if it cannot
|
|
875
|
+
* safely receive that baseline. Stale browsers cannot be acquired. Other network
|
|
876
|
+
* fields only apply to browsers created after the update; existing browsers keep
|
|
877
|
+
* those fields until discarded (see discard_all_idle).
|
|
863
878
|
*/
|
|
864
879
|
network?: BrowsersAPI.BrowserNetworkConfig;
|
|
865
880
|
|
|
@@ -349,7 +349,7 @@ export type ProfilesOffsetPagination = OffsetPagination<Profile>;
|
|
|
349
349
|
/**
|
|
350
350
|
* Memory allocated to the browser session.
|
|
351
351
|
*/
|
|
352
|
-
export type BrowserMemory = '1GiB' | '2GiB' | '6GiB' | '8GiB' | '16GiB';
|
|
352
|
+
export type BrowserMemory = '1GiB' | '2GiB' | '6GiB' | '8GiB' | '12GiB' | '16GiB';
|
|
353
353
|
|
|
354
354
|
/**
|
|
355
355
|
* Memory requested for a headful, non-GPU browser session.
|
|
@@ -379,8 +379,11 @@ export interface BrowserNetworkConfig {
|
|
|
379
379
|
* Enforced at Kernel's egress proxy only: destinations in private_hosts, and
|
|
380
380
|
* processes in the browser VM that do not use the browser's proxy, are not
|
|
381
381
|
* filtered, and Kernel's own control traffic is always allowed. Can be replaced or
|
|
382
|
-
* removed while the session runs with PATCH /browsers/{id_or_name}
|
|
383
|
-
*
|
|
382
|
+
* removed while the session runs with PATCH /browsers/{id_or_name}, but not added
|
|
383
|
+
* to a browser created without one. Supported on browser pools and their leased
|
|
384
|
+
* browsers. Per-lease changes are reset to the pool's allowlist on release. If a
|
|
385
|
+
* lessee removes the allowlist and the pool still requires one, the browser is
|
|
386
|
+
* replaced on release rather than given an allowlist again. Requires proxy v3.
|
|
384
387
|
*/
|
|
385
388
|
allowed_hosts?: Array<string>;
|
|
386
389
|
|
|
@@ -411,20 +414,20 @@ export interface BrowserNetworkConfig {
|
|
|
411
414
|
private_hosts?: Array<string>;
|
|
412
415
|
|
|
413
416
|
/**
|
|
414
|
-
* Per-destination proxy routes for a browser session.
|
|
415
|
-
*
|
|
416
|
-
*
|
|
417
|
-
*
|
|
418
|
-
* "_.
|
|
419
|
-
*
|
|
420
|
-
*
|
|
421
|
-
*
|
|
422
|
-
*
|
|
423
|
-
*
|
|
424
|
-
*
|
|
425
|
-
*
|
|
426
|
-
*
|
|
427
|
-
*
|
|
417
|
+
* Per-destination proxy routes for a browser session. A destination hostname is
|
|
418
|
+
* matched against every route's hosts, regardless of port; route order does not
|
|
419
|
+
* matter. An exact hostname beats a wildcard, and a longer wildcard suffix beats a
|
|
420
|
+
* shorter one (for a.b.example.com: "a.b.example.com" > "_.b.example.com" >
|
|
421
|
+
* "_.example.com"). A host pattern may appear in only one route. "\*.example.com"
|
|
422
|
+
* matches subdomains only, not example.com. A matched request selects the route's
|
|
423
|
+
* proxy instead of the session's top-level proxy (including mode: direct); the
|
|
424
|
+
* route proxy's own bypass_hosts still apply. If the route proxy becomes
|
|
425
|
+
* unavailable, matched requests fail closed without falling back. Requests that
|
|
426
|
+
* match no route use the session's default egress from the top-level proxy field
|
|
427
|
+
* (or the browser default when proxy is omitted: stealth proxy or direct egress).
|
|
428
|
+
* Routes apply from the start of the session, including to start_url and other
|
|
429
|
+
* traffic during browser setup. Setting routes requires proxy v3. Browser pools
|
|
430
|
+
* also support these routes.
|
|
428
431
|
*/
|
|
429
432
|
proxy_routes?: Array<BrowserNetworkConfig.ProxyRoute>;
|
|
430
433
|
}
|
|
@@ -464,16 +467,20 @@ export namespace BrowserNetworkConfig {
|
|
|
464
467
|
export interface BrowserNetworkUpdate {
|
|
465
468
|
/**
|
|
466
469
|
* Replaces the session's egress allowlist, using the same entry rules as
|
|
467
|
-
* network.allowed_hosts on create.
|
|
468
|
-
*
|
|
469
|
-
*
|
|
470
|
-
*
|
|
471
|
-
*
|
|
472
|
-
*
|
|
473
|
-
*
|
|
474
|
-
*
|
|
475
|
-
*
|
|
476
|
-
*
|
|
470
|
+
* network.allowed_hosts on create. Only an allowlist the browser was created with
|
|
471
|
+
* can be changed: a browser created without one can't be given one, and an
|
|
472
|
+
* allowlist removed with null can't be added back. Omit to leave the allowlist
|
|
473
|
+
* unchanged, or set to null to remove it and return to unfiltered egress; an empty
|
|
474
|
+
* list is invalid. The new list applies without restarting the browser: new
|
|
475
|
+
* requests to destinations it no longer allows are refused within a few seconds,
|
|
476
|
+
* and open connections to them are closed within about 30 seconds, or up to 10
|
|
477
|
+
* minutes during a Kernel deploy. Connections to destinations it still allows,
|
|
478
|
+
* such as WebSockets, stay open. A start_url in the same request must be allowed
|
|
479
|
+
* by the updated list, and is loaded only after the list takes effect. Requires a
|
|
480
|
+
* browser created with proxy v3. Supported on leased pooled browsers; the pool's
|
|
481
|
+
* allowlist is restored before reuse, or the browser is destroyed if it cannot be
|
|
482
|
+
* safely restored. If the request fails, retry it: the new list may already apply
|
|
483
|
+
* to some requests.
|
|
477
484
|
*/
|
|
478
485
|
allowed_hosts?: Array<string> | null;
|
|
479
486
|
}
|
|
@@ -667,6 +674,12 @@ export interface BrowserUsage {
|
|
|
667
674
|
uptime_ms: number;
|
|
668
675
|
}
|
|
669
676
|
|
|
677
|
+
/**
|
|
678
|
+
* Video memory (VRAM) of a GPU browser session. 2GiB sessions have 4 vCPU and 6GiB
|
|
679
|
+
* memory. 4GiB sessions have 8 vCPU and 12GiB memory.
|
|
680
|
+
*/
|
|
681
|
+
export type BrowserVideoMemory = '2GiB' | '4GiB';
|
|
682
|
+
|
|
670
683
|
/**
|
|
671
684
|
* Browser profile metadata.
|
|
672
685
|
*/
|
|
@@ -865,6 +878,11 @@ export interface BrowserCreateResponse {
|
|
|
865
878
|
*/
|
|
866
879
|
vaults?: Array<VaultReference>;
|
|
867
880
|
|
|
881
|
+
/**
|
|
882
|
+
* Video memory (VRAM) of the GPU browser session. Only present when gpu is true.
|
|
883
|
+
*/
|
|
884
|
+
video_memory?: BrowserVideoMemory;
|
|
885
|
+
|
|
868
886
|
/**
|
|
869
887
|
* Initial browser window size in pixels with optional refresh rate. If omitted,
|
|
870
888
|
* image defaults apply (1920x1080@25). For GPU images, the default is
|
|
@@ -1036,6 +1054,11 @@ export interface BrowserRetrieveResponse {
|
|
|
1036
1054
|
*/
|
|
1037
1055
|
vaults?: Array<VaultReference>;
|
|
1038
1056
|
|
|
1057
|
+
/**
|
|
1058
|
+
* Video memory (VRAM) of the GPU browser session. Only present when gpu is true.
|
|
1059
|
+
*/
|
|
1060
|
+
video_memory?: BrowserVideoMemory;
|
|
1061
|
+
|
|
1039
1062
|
/**
|
|
1040
1063
|
* Initial browser window size in pixels with optional refresh rate. If omitted,
|
|
1041
1064
|
* image defaults apply (1920x1080@25). For GPU images, the default is
|
|
@@ -1207,6 +1230,11 @@ export interface BrowserUpdateResponse {
|
|
|
1207
1230
|
*/
|
|
1208
1231
|
vaults?: Array<VaultReference>;
|
|
1209
1232
|
|
|
1233
|
+
/**
|
|
1234
|
+
* Video memory (VRAM) of the GPU browser session. Only present when gpu is true.
|
|
1235
|
+
*/
|
|
1236
|
+
video_memory?: BrowserVideoMemory;
|
|
1237
|
+
|
|
1210
1238
|
/**
|
|
1211
1239
|
* Initial browser window size in pixels with optional refresh rate. If omitted,
|
|
1212
1240
|
* image defaults apply (1920x1080@25). For GPU images, the default is
|
|
@@ -1378,6 +1406,11 @@ export interface BrowserListResponse {
|
|
|
1378
1406
|
*/
|
|
1379
1407
|
vaults?: Array<VaultReference>;
|
|
1380
1408
|
|
|
1409
|
+
/**
|
|
1410
|
+
* Video memory (VRAM) of the GPU browser session. Only present when gpu is true.
|
|
1411
|
+
*/
|
|
1412
|
+
video_memory?: BrowserVideoMemory;
|
|
1413
|
+
|
|
1381
1414
|
/**
|
|
1382
1415
|
* Initial browser window size in pixels with optional refresh rate. If omitted,
|
|
1383
1416
|
* image defaults apply (1920x1080@25). For GPU images, the default is
|
|
@@ -1553,6 +1586,13 @@ export interface BrowserCreateParams {
|
|
|
1553
1586
|
*/
|
|
1554
1587
|
vaults?: Array<VaultReference>;
|
|
1555
1588
|
|
|
1589
|
+
/**
|
|
1590
|
+
* Video memory (VRAM) for a GPU browser session. Requires gpu=true. Defaults to
|
|
1591
|
+
* 2GiB, which comes with 4 vCPU and 6GiB memory. 4GiB comes with 8 vCPU and 12GiB
|
|
1592
|
+
* memory.
|
|
1593
|
+
*/
|
|
1594
|
+
video_memory?: BrowserVideoMemory;
|
|
1595
|
+
|
|
1556
1596
|
/**
|
|
1557
1597
|
* Initial browser window size in pixels with optional refresh rate. If omitted,
|
|
1558
1598
|
* image defaults apply (1920x1080@25). For GPU images, the default is
|
|
@@ -2013,6 +2053,7 @@ export declare namespace Browsers {
|
|
|
2013
2053
|
type BrowserReplResult as BrowserReplResult,
|
|
2014
2054
|
type BrowserReplTextContent as BrowserReplTextContent,
|
|
2015
2055
|
type BrowserUsage as BrowserUsage,
|
|
2056
|
+
type BrowserVideoMemory as BrowserVideoMemory,
|
|
2016
2057
|
type Profile as Profile,
|
|
2017
2058
|
type Tags as Tags,
|
|
2018
2059
|
type VaultReference as VaultReference,
|