@scalekit-sdk/node 2.1.8 → 2.2.0-beta.0

package/src/connected-accounts.ts

@@ -0,0 +1,283 @@
+import { PartialMessage } from "@bufbuild/protobuf";
+import { PromiseClient } from "@connectrpc/connect";
+import GrpcConnect from "./connect";
+import CoreClient from "./core";
+import { ConnectedAccountService } from "./pkg/grpc/scalekit/v1/connected_accounts/connected_accounts_connect";
+import {
+  CreateConnectedAccount,
+  CreateConnectedAccountRequest,
+  CreateConnectedAccountResponse,
+  DeleteConnectedAccountRequest,
+  DeleteConnectedAccountResponse,
+  GetConnectedAccountByIdentifierRequest,
+  GetConnectedAccountByIdentifierResponse,
+  GetMagicLinkForConnectedAccountRequest,
+  GetMagicLinkForConnectedAccountResponse,
+  ListConnectedAccountsRequest,
+  ListConnectedAccountsResponse,
+  UpdateConnectedAccount,
+  UpdateConnectedAccountRequest,
+  UpdateConnectedAccountResponse,
+} from "./pkg/grpc/scalekit/v1/connected_accounts/connected_accounts_pb";
+
+/**
+ * Client for managing connected accounts for third-party integrations.
+ *
+ * This mirrors the Python SDK `ConnectedAccountsClient` and exposes a typed,
+ * ergonomic API around the `ConnectedAccountService` to:
+ * - list connected accounts
+ * - create/update/delete connected accounts
+ * - generate magic links for authorization
+ * - fetch full authentication details for a connected account
+ */
+export default class ConnectedAccountsClient {
+  private client: PromiseClient<typeof ConnectedAccountService>;
+
+  constructor(
+    private readonly grpcConnect: GrpcConnect,
+    private readonly coreClient: CoreClient
+  ) {
+    this.client = this.grpcConnect.createClient(ConnectedAccountService);
+  }
+
+  /**
+   * Lists connected accounts with optional filters and pagination.
+   *
+   * @param options Optional filtering and pagination parameters
+   */
+  async listConnectedAccounts(options?: {
+    organizationId?: string;
+    userId?: string;
+    connector?: string;
+    identifier?: string;
+    provider?: string;
+    pageSize?: number;
+    pageToken?: string;
+    query?: string;
+  }): Promise<ListConnectedAccountsResponse> {
+    const request: PartialMessage<ListConnectedAccountsRequest> = {};
+
+    if (options?.organizationId) {
+      request.organizationId = options.organizationId;
+    }
+    if (options?.userId) {
+      request.userId = options.userId;
+    }
+    if (options?.connector) {
+      request.connector = options.connector;
+    }
+    if (options?.identifier) {
+      request.identifier = options.identifier;
+    }
+    if (options?.provider) {
+      request.provider = options.provider;
+    }
+    if (options?.pageSize !== undefined) {
+      request.pageSize = options.pageSize;
+    }
+    if (options?.pageToken) {
+      request.pageToken = options.pageToken;
+    }
+    if (options?.query) {
+      request.query = options.query;
+    }
+
+    return this.coreClient.connectExec(
+      this.client.listConnectedAccounts,
+      request
+    );
+  }
+
+  /**
+   * Creates a new connected account.
+   *
+   * @param params Connected account creation parameters
+   */
+  async createConnectedAccount(params: {
+    connector: string;
+    identifier: string;
+    connectedAccount: CreateConnectedAccount;
+    organizationId?: string;
+    userId?: string;
+  }): Promise<CreateConnectedAccountResponse> {
+    const {
+      connector,
+      identifier,
+      connectedAccount,
+      organizationId,
+      userId,
+    } = params;
+
+    const request: PartialMessage<CreateConnectedAccountRequest> = {
+      connector,
+      identifier,
+      connectedAccount,
+    };
+
+    if (organizationId) {
+      request.organizationId = organizationId;
+    }
+    if (userId) {
+      request.userId = userId;
+    }
+
+    return this.coreClient.connectExec(
+      this.client.createConnectedAccount,
+      request
+    );
+  }
+
+  /**
+   * Updates an existing connected account.
+   *
+   * You can target the account either by `connectedAccountId` or by the combination
+   * of `organizationId`/`userId`, `connector`, and `identifier`.
+   */
+  async updateConnectedAccount(params: {
+    connector: string;
+    identifier: string;
+    connectedAccount: UpdateConnectedAccount;
+    organizationId?: string;
+    userId?: string;
+    connectedAccountId?: string;
+  }): Promise<UpdateConnectedAccountResponse> {
+    const {
+      connector,
+      identifier,
+      connectedAccount,
+      organizationId,
+      userId,
+      connectedAccountId,
+    } = params;
+
+    const request: PartialMessage<UpdateConnectedAccountRequest> = {
+      connector,
+      identifier,
+      connectedAccount,
+    };
+
+    if (organizationId) {
+      request.organizationId = organizationId;
+    }
+    if (userId) {
+      request.userId = userId;
+    }
+    if (connectedAccountId) {
+      request.id = connectedAccountId;
+    }
+
+    return this.coreClient.connectExec(
+      this.client.updateConnectedAccount,
+      request
+    );
+  }
+
+  /**
+   * Deletes a connected account and revokes its credentials.
+   *
+   * You can target the account either by `connectedAccountId` or by the combination
+   * of `organizationId`/`userId`, `connector`, and `identifier`.
+   */
+  async deleteConnectedAccount(params: {
+    connector: string;
+    identifier: string;
+    organizationId?: string;
+    userId?: string;
+    connectedAccountId?: string;
+  }): Promise<DeleteConnectedAccountResponse> {
+    const { connector, identifier, organizationId, userId, connectedAccountId } =
+      params;
+
+    const request: PartialMessage<DeleteConnectedAccountRequest> = {
+      connector,
+      identifier,
+    };
+
+    if (organizationId) {
+      request.organizationId = organizationId;
+    }
+    if (userId) {
+      request.userId = userId;
+    }
+    if (connectedAccountId) {
+      request.id = connectedAccountId;
+    }
+
+    return this.coreClient.connectExec(
+      this.client.deleteConnectedAccount,
+      request
+    );
+  }
+
+  /**
+   * Generates a time-limited magic link for connecting or re-authorizing a third-party account.
+   */
+  async getMagicLinkForConnectedAccount(params: {
+    connector: string;
+    identifier: string;
+    organizationId?: string;
+    userId?: string;
+    connectedAccountId?: string;
+  }): Promise<GetMagicLinkForConnectedAccountResponse> {
+    const { connector, identifier, organizationId, userId, connectedAccountId } =
+      params;
+
+    const request: PartialMessage<GetMagicLinkForConnectedAccountRequest> = {
+      connector,
+      identifier,
+    };
+
+    if (organizationId) {
+      request.organizationId = organizationId;
+    }
+    if (userId) {
+      request.userId = userId;
+    }
+    if (connectedAccountId) {
+      request.id = connectedAccountId;
+    }
+
+    return this.coreClient.connectExec(
+      this.client.getMagicLinkForConnectedAccount,
+      request
+    );
+  }
+
+  /**
+   * Retrieves complete authentication details for a connected account.
+   *
+   * This method returns sensitive credential information, so ensure you protect access
+   * to this in your application.
+   */
+  async getConnectedAccountByIdentifier(params: {
+    connector: string;
+    identifier: string;
+    organizationId?: string;
+    userId?: string;
+    connectedAccountId?: string;
+  }): Promise<GetConnectedAccountByIdentifierResponse> {
+    const { connector, identifier, organizationId, userId, connectedAccountId } =
+      params;
+
+    const request: PartialMessage<GetConnectedAccountByIdentifierRequest> = {
+      connector,
+      identifier,
+    };
+
+    if (organizationId) {
+      request.organizationId = organizationId;
+    }
+    if (userId) {
+      request.userId = userId;
+    }
+    if (connectedAccountId) {
+      request.id = connectedAccountId;
+    }
+
+    return this.coreClient.connectExec(
+      this.client.getConnectedAccountAuth,
+      request
+    );
+  }
+}
+

package/src/core.ts

@@ -23,8 +23,8 @@ export default class CoreClient {
   public keys: JWK[] = [];
   public accessToken: string | null = null;
   public axios: Axios;
-  public sdkVersion = `Scalekit-Node/2.1.8`;
-  public apiVersion = "20251215";
+  public sdkVersion = `Scalekit-Node/2.2.0-beta.0`;
+  public apiVersion = "20260123";
   public userAgent = `${this.sdkVersion} Node/${process.version} (${
     process.platform
   }; ${os.arch()})`;

package/src/domain.ts

@@ -114,7 +114,7 @@ export default class DomainClient {
       },
       domain: {
         domain: name,
-        ...(domainTypeValue && { domainType: domainTypeValue }),
+        ...(!!domainTypeValue && { domainType: domainTypeValue }),
       },
     });
   }
@@ -175,6 +175,20 @@ export default class DomainClient {
     });
   }
 
+  private resolveDomainType(
+    domainType?: DomainType | string
+  ): DomainType | undefined {
+    if (domainType == null) return;
+    if (typeof domainType !== 'string') return domainType;
+    const resolved = DomainType[domainType as keyof typeof DomainType];
+    if (resolved === undefined) {
+      throw new Error(
+        `Invalid domain type: ${domainType}. Expected ALLOWED_EMAIL_DOMAIN or ORGANIZATION_DOMAIN`
+      );
+    }
+    return resolved;
+  }
+
   /**
    * Retrieves all domain configurations for an organization.
    *
@@ -187,6 +201,8 @@ export default class DomainClient {
    *
    * @param {string} organizationId - The organization ID (format: "org_...")
    *
+   * @param options Optional parameters for filtering domains
+   * @param {DomainType | string} options.domainType Filter domains by type (ALLOWED_EMAIL_DOMAIN or ORGANIZATION_DOMAIN)
    * @returns {Promise<ListDomainResponse>} List of all domains with their configurations
    *
    * @example
@@ -209,13 +225,19 @@ export default class DomainClient {
    * @see {@link getDomain} - Get details for a specific domain
    * @see {@link deleteDomain} - Remove a domain
    */
-  async listDomains(organizationId: string): Promise<ListDomainResponse> {
-    return this.coreClient.connectExec(this.client.listDomains, {
-      identities: {
-        case: "organizationId",
-        value: organizationId,
+  async listDomains(organizationId: string, options?: { domainType?: DomainType | string }): Promise<ListDomainResponse> {
+    const domainTypeValue = this.resolveDomainType(options?.domainType);
+
+    return this.coreClient.connectExec(
+      this.client.listDomains,
+      {
+        identities: {
+          case: 'organizationId',
+          value: organizationId
+        },
+        ...(!!domainTypeValue && { domainType: domainTypeValue })
       },
-    });
+    );
   }
 
   /**

package/src/pkg/grpc/scalekit/v1/auditlogs/auditlogs_pb.ts

@@ -45,6 +45,16 @@ export class ListAuthLogRequest extends Message<ListAuthLogRequest> {
    */
   resourceId = "";
 
+  /**
+   * @generated from field: string connected_account_identifier = 8;
+   */
+  connectedAccountIdentifier = "";
+
+  /**
+   * @generated from field: string client_id = 9;
+   */
+  clientId = "";
+
   constructor(data?: PartialMessage<ListAuthLogRequest>) {
     super();
     proto3.util.initPartial(data, this);
@@ -60,6 +70,8 @@ export class ListAuthLogRequest extends Message<ListAuthLogRequest> {
     { no: 5, name: "start_time", kind: "message", T: Timestamp },
     { no: 6, name: "end_time", kind: "message", T: Timestamp },
     { no: 7, name: "resource_id", kind: "scalar", T: 9 /* ScalarType.STRING */ },
+    { no: 8, name: "connected_account_identifier", kind: "scalar", T: 9 /* ScalarType.STRING */ },
+    { no: 9, name: "client_id", kind: "scalar", T: 9 /* ScalarType.STRING */ },
   ]);
 
   static fromBinary(bytes: Uint8Array, options?: Partial<BinaryReadOptions>): ListAuthLogRequest {
@@ -208,6 +220,26 @@ export class AuthLogRequest extends Message<AuthLogRequest> {
    */
   resourceType = "";
 
+  /**
+   * @generated from field: string connected_account_identifier = 15;
+   */
+  connectedAccountIdentifier = "";
+
+  /**
+   * @generated from field: string client_id = 16;
+   */
+  clientId = "";
+
+  /**
+   * @generated from field: string client_name = 17;
+   */
+  clientName = "";
+
+  /**
+   * @generated from field: string client_type = 18;
+   */
+  clientType = "";
+
   constructor(data?: PartialMessage<AuthLogRequest>) {
     super();
     proto3.util.initPartial(data, this);
@@ -230,6 +262,10 @@ export class AuthLogRequest extends Message<AuthLogRequest> {
     { no: 12, name: "resource_id", kind: "scalar", T: 9 /* ScalarType.STRING */ },
     { no: 13, name: "resource_name", kind: "scalar", T: 9 /* ScalarType.STRING */ },
     { no: 14, name: "resource_type", kind: "scalar", T: 9 /* ScalarType.STRING */ },
+    { no: 15, name: "connected_account_identifier", kind: "scalar", T: 9 /* ScalarType.STRING */ },
+    { no: 16, name: "client_id", kind: "scalar", T: 9 /* ScalarType.STRING */ },
+    { no: 17, name: "client_name", kind: "scalar", T: 9 /* ScalarType.STRING */ },
+    { no: 18, name: "client_type", kind: "scalar", T: 9 /* ScalarType.STRING */ },
   ]);
 
   static fromBinary(bytes: Uint8Array, options?: Partial<BinaryReadOptions>): AuthLogRequest {

package/src/pkg/grpc/scalekit/v1/auth/auth_pb.ts

@@ -116,6 +116,26 @@ export enum AuthState {
    * @generated from enum value: WEBAUTHN_VERIFIED = 15;
    */
   WEBAUTHN_VERIFIED = 15,
+
+  /**
+   * @generated from enum value: VERIFICATION_MAGIC_LINK_SENT = 16;
+   */
+  VERIFICATION_MAGIC_LINK_SENT = 16,
+
+  /**
+   * @generated from enum value: VERIFICATION_MAGIC_LINK_OTP_SENT = 17;
+   */
+  VERIFICATION_MAGIC_LINK_OTP_SENT = 17,
+
+  /**
+   * @generated from enum value: VERIFICATION_OTP_SENT = 18;
+   */
+  VERIFICATION_OTP_SENT = 18,
+
+  /**
+   * @generated from enum value: VERIFICATION_COMPLETED = 19;
+   */
+  VERIFICATION_COMPLETED = 19,
 }
 // Retrieve enum metadata with: proto3.getEnumType(AuthState)
 proto3.util.setEnumType(AuthState, "scalekit.v1.auth.AuthState", [
@@ -135,6 +155,10 @@ proto3.util.setEnumType(AuthState, "scalekit.v1.auth.AuthState", [
   { no: 13, name: "AUTHENTICATION_COMPLETED" },
   { no: 14, name: "AUTHENTICATION_FAILED" },
   { no: 15, name: "WEBAUTHN_VERIFIED" },
+  { no: 16, name: "VERIFICATION_MAGIC_LINK_SENT" },
+  { no: 17, name: "VERIFICATION_MAGIC_LINK_OTP_SENT" },
+  { no: 18, name: "VERIFICATION_OTP_SENT" },
+  { no: 19, name: "VERIFICATION_COMPLETED" },
 ]);
 
 /**
@@ -1073,6 +1097,11 @@ export class GetAuthStateResponse extends Message<GetAuthStateResponse> {
    */
   authState = AuthState.AUTH_STATE_UNSPECIFIED;
 
+  /**
+   * @generated from field: scalekit.v1.auth.UserDetails user = 2;
+   */
+  user?: UserDetails;
+
   constructor(data?: PartialMessage<GetAuthStateResponse>) {
     super();
     proto3.util.initPartial(data, this);
@@ -1082,6 +1111,7 @@ export class GetAuthStateResponse extends Message<GetAuthStateResponse> {
   static readonly typeName = "scalekit.v1.auth.GetAuthStateResponse";
   static readonly fields: FieldList = proto3.util.newFieldList(() => [
     { no: 1, name: "auth_state", kind: "enum", T: proto3.getEnumType(AuthState) },
+    { no: 2, name: "user", kind: "message", T: UserDetails },
   ]);
 
   static fromBinary(bytes: Uint8Array, options?: Partial<BinaryReadOptions>): GetAuthStateResponse {

package/src/pkg/grpc/scalekit/v1/commons/commons_pb.ts

@@ -247,6 +247,11 @@ export class OrganizationMembership extends Message<OrganizationMembership> {
    */
   provisioningMethod?: string;
 
+  /**
+   * @generated from field: repeated string permissions = 15;
+   */
+  permissions: string[] = [];
+
   constructor(data?: PartialMessage<OrganizationMembership>) {
     super();
     proto3.util.initPartial(data, this);
@@ -267,6 +272,7 @@ export class OrganizationMembership extends Message<OrganizationMembership> {
     { no: 12, name: "accepted_at", kind: "message", T: Timestamp, opt: true },
     { no: 13, name: "expires_at", kind: "message", T: Timestamp, opt: true },
     { no: 14, name: "provisioning_method", kind: "scalar", T: 9 /* ScalarType.STRING */, opt: true },
+    { no: 15, name: "permissions", kind: "scalar", T: 9 /* ScalarType.STRING */, repeated: true },
   ]);
 
   static fromBinary(bytes: Uint8Array, options?: Partial<BinaryReadOptions>): OrganizationMembership {

package/src/pkg/grpc/scalekit/v1/connected_accounts/connected_accounts_connect.ts

@@ -0,0 +1,94 @@
+// @generated by protoc-gen-connect-es v1.4.0 with parameter "target=ts"
+// @generated from file scalekit/v1/connected_accounts/connected_accounts.proto (package scalekit.v1.connected_accounts, syntax proto3)
+/* eslint-disable */
+// @ts-nocheck
+
+import { CreateConnectedAccountRequest, CreateConnectedAccountResponse, DeleteConnectedAccountRequest, DeleteConnectedAccountResponse, GetConnectedAccountByIdentifierRequest, GetConnectedAccountByIdentifierResponse, GetMagicLinkForConnectedAccountRequest, GetMagicLinkForConnectedAccountResponse, ListConnectedAccountsRequest, ListConnectedAccountsResponse, SearchConnectedAccountsRequest, SearchConnectedAccountsResponse, UpdateConnectedAccountRequest, UpdateConnectedAccountResponse } from "./connected_accounts_pb.js";
+import { MethodKind } from "@bufbuild/protobuf";
+
+/**
+ * @generated from service scalekit.v1.connected_accounts.ConnectedAccountService
+ */
+export const ConnectedAccountService = {
+  typeName: "scalekit.v1.connected_accounts.ConnectedAccountService",
+  methods: {
+    /**
+     * List Connected Accounts
+     *
+     * @generated from rpc scalekit.v1.connected_accounts.ConnectedAccountService.ListConnectedAccounts
+     */
+    listConnectedAccounts: {
+      name: "ListConnectedAccounts",
+      I: ListConnectedAccountsRequest,
+      O: ListConnectedAccountsResponse,
+      kind: MethodKind.Unary,
+    },
+    /**
+     * Search Connected Accounts
+     *
+     * @generated from rpc scalekit.v1.connected_accounts.ConnectedAccountService.SearchConnectedAccounts
+     */
+    searchConnectedAccounts: {
+      name: "SearchConnectedAccounts",
+      I: SearchConnectedAccountsRequest,
+      O: SearchConnectedAccountsResponse,
+      kind: MethodKind.Unary,
+    },
+    /**
+     * Create Connected Account
+     *
+     * @generated from rpc scalekit.v1.connected_accounts.ConnectedAccountService.CreateConnectedAccount
+     */
+    createConnectedAccount: {
+      name: "CreateConnectedAccount",
+      I: CreateConnectedAccountRequest,
+      O: CreateConnectedAccountResponse,
+      kind: MethodKind.Unary,
+    },
+    /**
+     * Update Connected Account
+     *
+     * @generated from rpc scalekit.v1.connected_accounts.ConnectedAccountService.UpdateConnectedAccount
+     */
+    updateConnectedAccount: {
+      name: "UpdateConnectedAccount",
+      I: UpdateConnectedAccountRequest,
+      O: UpdateConnectedAccountResponse,
+      kind: MethodKind.Unary,
+    },
+    /**
+     * Delete Connected Account
+     *
+     * @generated from rpc scalekit.v1.connected_accounts.ConnectedAccountService.DeleteConnectedAccount
+     */
+    deleteConnectedAccount: {
+      name: "DeleteConnectedAccount",
+      I: DeleteConnectedAccountRequest,
+      O: DeleteConnectedAccountResponse,
+      kind: MethodKind.Unary,
+    },
+    /**
+     * Generate Magic Link for Account Connection
+     *
+     * @generated from rpc scalekit.v1.connected_accounts.ConnectedAccountService.GetMagicLinkForConnectedAccount
+     */
+    getMagicLinkForConnectedAccount: {
+      name: "GetMagicLinkForConnectedAccount",
+      I: GetMagicLinkForConnectedAccountRequest,
+      O: GetMagicLinkForConnectedAccountResponse,
+      kind: MethodKind.Unary,
+    },
+    /**
+     * Get Connected Account Authentication Details
+     *
+     * @generated from rpc scalekit.v1.connected_accounts.ConnectedAccountService.GetConnectedAccountAuth
+     */
+    getConnectedAccountAuth: {
+      name: "GetConnectedAccountAuth",
+      I: GetConnectedAccountByIdentifierRequest,
+      O: GetConnectedAccountByIdentifierResponse,
+      kind: MethodKind.Unary,
+    },
+  }
+} as const;
+