@1password/sdk 0.0.0-credential-broker-dev-preview → 0.0.0-credential-broker-dev-preview.1

package/dist/configuration.d.ts

@@ -1,6 +1,6 @@
 import { ClientAuthConfig, WorkloadDetails } from "./core.js";
 export declare const LANGUAGE = "JS";
-export declare const VERSION = "0000000";
+export declare const VERSION = "0000001";
 interface BaseClientConfiguration {
     integrationName: string;
     integrationVersion: string;

package/dist/credential_broker_access_requests.d.ts

@@ -1,5 +1,5 @@
 import { InnerClient } from "./core.js";
-import { AccessRequest, AccessRequestCreateParams, AccessRequestStatus } from "./types.js";
+import { AccessRequestCreateParams, AccessRequestCreateResponse, AccessRequestStatus } from "./types.js";
 /**
  * Create and poll credential-broker access requests: asking a target
  * identity to grant this workload access to one or more credentials.
@@ -14,9 +14,10 @@ export interface CredentialBrokerAccessRequestsApi {
      * authenticated workload.
      *
      * Only the non-sensitive half is registered server-side; the returned
-     * request is the full object with the presentation fields re-attached.
+     * request is the full object with the presentation fields re-attached,
+     * alongside the app link that carries them to the approval prompt.
      */
-    create(params: AccessRequestCreateParams): Promise<AccessRequest>;
+    create(params: AccessRequestCreateParams): Promise<AccessRequestCreateResponse>;
     /**
      * Get the current status of an access request created by
      * [`AccessRequests::create`].
@@ -32,9 +33,10 @@ export declare class CredentialBrokerAccessRequests implements CredentialBrokerA
      * authenticated workload.
      *
      * Only the non-sensitive half is registered server-side; the returned
-     * request is the full object with the presentation fields re-attached.
+     * request is the full object with the presentation fields re-attached,
+     * alongside the app link that carries them to the approval prompt.
      */
-    create(params: AccessRequestCreateParams): Promise<AccessRequest>;
+    create(params: AccessRequestCreateParams): Promise<AccessRequestCreateResponse>;
     /**
      * Get the current status of an access request created by
      * [`AccessRequests::create`].

package/dist/credential_broker_access_requests.js

@@ -35,7 +35,8 @@ class CredentialBrokerAccessRequests {
      * authenticated workload.
      *
      * Only the non-sensitive half is registered server-side; the returned
-     * request is the full object with the presentation fields re-attached.
+     * request is the full object with the presentation fields re-attached,
+     * alongside the app link that carries them to the approval prompt.
      */
     create(params) {
         return __awaiter(this, void 0, void 0, function* () {

package/dist/credential_broker_environment_variables.d.ts

@@ -1,5 +1,5 @@
 import { InnerClient } from "./core.js";
-import { CredentialReference, EnvironmentCredential } from "./types.js";
+import { EnvironmentCredential } from "./types.js";
 /**
  * Read environment credentials — a bundle of environment variables — from
  * the 1Password Credential Broker.
@@ -16,7 +16,7 @@ export interface CredentialBrokerEnvironmentVariablesApi {
      * or does not name an environment credential, or with [Error::CredentialReferenceAccountMismatch]
      * if it belongs to a different account than the authenticated client.
      */
-    read(credentialReference: CredentialReference): Promise<EnvironmentCredential>;
+    read(credentialReference: string): Promise<EnvironmentCredential>;
 }
 export declare class CredentialBrokerEnvironmentVariables implements CredentialBrokerEnvironmentVariablesApi {
     #private;
@@ -29,5 +29,5 @@ export declare class CredentialBrokerEnvironmentVariables implements CredentialB
      * or does not name an environment credential, or with [Error::CredentialReferenceAccountMismatch]
      * if it belongs to a different account than the authenticated client.
      */
-    read(credentialReference: CredentialReference): Promise<EnvironmentCredential>;
+    read(credentialReference: string): Promise<EnvironmentCredential>;
 }

package/dist/credential_broker_logins.d.ts

@@ -1,5 +1,5 @@
 import { InnerClient } from "./core.js";
-import { CredentialReference, LoginCredential, LoginDetails } from "./types.js";
+import { LoginCredential, LoginDetails } from "./types.js";
 /**
  * Read login credentials from the 1Password Credential Broker.
  * Accessed as `client.credential_broker.logins` in the generated SDK bindings.
@@ -13,11 +13,11 @@ export interface CredentialBrokerLoginsApi {
      * or does not name a login credential, or with [Error::CredentialReferenceAccountMismatch]
      * if it belongs to a different account than the authenticated client.
      */
-    read(credentialReference: CredentialReference): Promise<LoginCredential>;
+    read(credentialReference: string): Promise<LoginCredential>;
     /**
      * Fetch non-secret details for the login identified by `credential_reference`.
      */
-    getDetails(credentialReference: CredentialReference): Promise<LoginDetails>;
+    getDetails(credentialReference: string): Promise<LoginDetails>;
 }
 export declare class CredentialBrokerLogins implements CredentialBrokerLoginsApi {
     #private;
@@ -30,9 +30,9 @@ export declare class CredentialBrokerLogins implements CredentialBrokerLoginsApi
      * or does not name a login credential, or with [Error::CredentialReferenceAccountMismatch]
      * if it belongs to a different account than the authenticated client.
      */
-    read(credentialReference: CredentialReference): Promise<LoginCredential>;
+    read(credentialReference: string): Promise<LoginCredential>;
     /**
      * Fetch non-secret details for the login identified by `credential_reference`.
      */
-    getDetails(credentialReference: CredentialReference): Promise<LoginDetails>;
+    getDetails(credentialReference: string): Promise<LoginDetails>;
 }

package/dist/types.d.ts

@@ -1,75 +1,53 @@
 export type ErrorMessage = string;
 /** The lifecycle state of an access request. */
 export declare enum AccessRequestState {
-    /** The request is awaiting a decision. */
+    /** The request awaits a decision. */
     Pending = "pending",
-    /** The request was approved and credentials were granted. */
+    /** The request was approved. */
     Resolved = "resolved",
-    /** The request was denied by the user. */
+    /** The request was denied. */
     Denied = "denied",
-    /** The request could not be processed. */
+    /** The request failed. */
     Failed = "failed"
 }
-/** The credential types an access request entry can ask for. */
+/** Credential types supported by access requests. */
 export declare enum AccessRequestEntryType {
-    /** A login credential (username / password / TOTP). */
+    /** A login credential. */
     Login = "login"
 }
-/** Type-specific parameters for a requested credential. */
+/** Type-specific access request parameters. */
 export interface AccessRequestEntryParameters {
     /** The website the requester needs to sign in to. */
-    website?: string;
+    website: string;
 }
 /** A requested credential within a created access request. */
 export interface AccessRequestEntry {
-    /**
-     * The SDK-minted identifier used to correlate this entry with a
-     * [`ResolvedAccessRequestEntry`] in the request status.
-     */
+    /** The SDK-minted identifier used to correlate this entry with its result. */
     id: string;
     /** The credential type requested. */
     type: AccessRequestEntryType;
     /** Type-specific request parameters. */
     parameters: AccessRequestEntryParameters;
-    /** Why this specific credential is needed, shown in the consent prompt. */
+    /** Why this credential is needed. */
     reason?: string;
-    /**
-     * Soft ranking signal used to order the candidate logins offered to the
-     * user.
-     */
+    /** A soft ranking signal for matching credentials. */
     keywords?: string[];
 }
 /** A server-managed access request. */
 export interface AccessRequest {
-    /**
-     * The canonical resource path.
-     * Format: `accounts/{account}/credential-broker-access-requests/{id}`
-     */
+    /** The canonical resource path. */
     path: string;
-    /**
-     * The client-generated identifier of the request. Pass to
-     * `credentialBroker.accessRequests.getStatus` to poll the request status.
-     */
+    /** The client-generated request identifier. */
     id: string;
-    /**
-     * The canonical AEP resource path of the identity for which
-     * credential access is requested.
-     */
+    /** The canonical target identity path. */
     identity: string;
     /** The current lifecycle state. */
     state: AccessRequestState;
-    /** The time the request was created. */
+    /** The request creation time. */
     createdAt: Date;
-    /**
-     * What the requester is trying to accomplish, shown to the user above
-     * the individual entries.
-     */
+    /** What the requester is trying to accomplish. */
     goal?: string;
-    /**
-     * The requested entries as created, each carrying its SDK-minted id.
-     * Correlate against [`ResolvedAccessRequestEntry::entry_id`] in the
-     * request status.
-     */
+    /** The requested entries. */
     entries: AccessRequestEntry[];
 }
 /** A single credential need within an access request. */
@@ -78,60 +56,45 @@ export interface AccessRequestEntryCreateParams {
     type: AccessRequestEntryType;
     /** Type-specific request parameters. */
     parameters: AccessRequestEntryParameters;
-    /** Why this specific credential is needed, shown in the consent prompt. */
+    /** Why this credential is needed. */
     reason?: string;
-    /**
-     * Soft ranking signal used to order the candidate logins offered to the
-     * user.
-     */
+    /** A soft ranking signal for matching credentials. */
     keywords?: string[];
 }
 /** The parameters for creating an access request. */
 export interface AccessRequestCreateParams {
-    /**
-     * What the requester is trying to accomplish, shown to the user above
-     * the individual entries.
-     */
+    /** What the requester is trying to accomplish. */
     goal?: string;
-    /**
-     * The requested credentials, in presentation order. Must contain
-     * between 1 and 5 entries.
-     */
+    /** The requested credentials, in presentation order. */
     entries: AccessRequestEntryCreateParams[];
 }
 /**
- * A reference to a 1Password Credential Broker configuration.
- *
- * Passed to a `client.credential_broker.<kind>.read` call to fetch a
- * credential. The `reference` string has the form:
- *
- * ```text
- * //api.1password.com/credential-broker/accounts/<account>/capability/<name>/configurations/<id>
- * ```
+ * A newly created access request plus the app link that opens its approval
+ * prompt.
  */
-export interface CredentialReference {
-    /** The reference path. */
-    reference: string;
+export interface AccessRequestCreateResponse {
+    /** The created access request. */
+    accessRequest: AccessRequest;
+    /**
+     * The `onepassword://` link that opens the approval prompt in the
+     * 1Password app.
+     */
+    appLink: string;
 }
 /** A credential granted in response to a requested entry. */
 export interface ResolvedAccessRequestEntry {
-    /**
-     * The requested entry satisfied by this credential, if any. When
-     * missing, this credential was additionally chosen during
-     * resolution on top of the requested credentials.
-     */
+    /** The requested entry satisfied by this credential. */
     entryId?: string;
-    /**
-     * The credential-broker reference to fetch the credential with
-     * (e.g. via `credentialBroker.logins.read`).
-     */
-    reference: CredentialReference;
+    /** The canonical relative Credential Broker reference. */
+    reference: string;
 }
 /** The non-sensitive status of an access request. */
 export interface AccessRequestStatus {
+    /** The canonical status resource path supplied by the service. */
+    path: string;
     /** The current lifecycle state. */
     state: AccessRequestState;
-    /** The credentials granted when the request is resolved. */
+    /** Credentials granted when the request is resolved. */
     resolved: ResolvedAccessRequestEntry[];
 }
 /** Additional attributes for OTP fields. */
@@ -671,27 +634,16 @@ export interface ItemsGetAllResponse {
 export interface ItemsUpdateAllResponse {
     individualResponses: Response<Item, ItemUpdateFailureReason>[];
 }
-/**
- * A login credential brokered by 1Password.
- * Fields are none when the corresponding item field doesn't exist.
- *
- * Returned by
- * [`Logins::read`](crate::client::Logins::read).
- */
+/** A login credential brokered by 1Password. */
 export interface LoginCredential {
-    /** The login's username. */
+    /** The login username. */
     username?: string;
-    /** The login's password. */
+    /** The login password. */
     password?: string;
-    /** Current one-time-password code, if the login has a TOTP field. */
+    /** The current one-time-password code. */
     totp?: string;
 }
-/**
- * Non-secret details for a brokered login.
- *
- * Returned by
- * [`Login::get_details`](crate::client::Login::get_details).
- */
+/** Non-secret details for a brokered login. */
 export interface LoginDetails {
     /** Website URLs associated with the login. */
     websites: string[];

package/dist/types.js

@@ -7,19 +7,19 @@ exports.ReplacerFunc = exports.ReviverFunc = exports.UPDATE_ITEM_HISTORY = expor
 /** The lifecycle state of an access request. */
 var AccessRequestState;
 (function (AccessRequestState) {
-    /** The request is awaiting a decision. */
+    /** The request awaits a decision. */
     AccessRequestState["Pending"] = "pending";
-    /** The request was approved and credentials were granted. */
+    /** The request was approved. */
     AccessRequestState["Resolved"] = "resolved";
-    /** The request was denied by the user. */
+    /** The request was denied. */
     AccessRequestState["Denied"] = "denied";
-    /** The request could not be processed. */
+    /** The request failed. */
     AccessRequestState["Failed"] = "failed";
 })(AccessRequestState || (exports.AccessRequestState = AccessRequestState = {}));
-/** The credential types an access request entry can ask for. */
+/** Credential types supported by access requests. */
 var AccessRequestEntryType;
 (function (AccessRequestEntryType) {
-    /** A login credential (username / password / TOTP). */
+    /** A login credential. */
     AccessRequestEntryType["Login"] = "login";
 })(AccessRequestEntryType || (exports.AccessRequestEntryType = AccessRequestEntryType = {}));
 var GroupType;

package/dist/version.d.ts

@@ -1,2 +1,2 @@
-export declare const SDK_VERSION = "0.0.0-credential-broker-dev-preview";
-export declare const SDK_BUILD_NUMBER = "0000000";
+export declare const SDK_VERSION = "0.0.0-credential-broker-dev-preview.1";
+export declare const SDK_BUILD_NUMBER = "0000001";

package/dist/version.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.SDK_BUILD_NUMBER = exports.SDK_VERSION = void 0;
-exports.SDK_VERSION = "0.0.0-credential-broker-dev-preview";
-exports.SDK_BUILD_NUMBER = "0000000";
-const SDK_CORE_VERSION = "0.0.0-credential-broker-dev-preview";
+exports.SDK_VERSION = "0.0.0-credential-broker-dev-preview.1";
+exports.SDK_BUILD_NUMBER = "0000001";
+const SDK_CORE_VERSION = "0.0.0-credential-broker-dev-preview.1";

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@1password/sdk",
-  "version": "0.0.0-credential-broker-dev-preview",
+  "version": "0.0.0-credential-broker-dev-preview.1",
   "description": "DEV PREVIEW — no backwards-compatibility guarantees, not for production use. The 1Password JavaScript SDK offers programmatic read access to your secrets in 1Password in an interface native to JavaScript. The SDK currently supports `Node.JS`",
   "scripts": {
     "build": "tsc",
@@ -33,7 +33,7 @@
   "main": "./dist/sdk.js",
   "types": "./dist/sdk.d.ts",
   "dependencies": {
-    "@1password/sdk-core": "0.0.0-credential-broker-dev-preview"
+    "@1password/sdk-core": "0.0.0-credential-broker-dev-preview.1"
   },
   "devDependencies": {
     "@1password/eslint-config": "^4.0.0",