@scalekit-sdk/node 1.0.2 → 1.0.4

package/src/pkg/grpc/scalekit/v1/organizations/organizations_pb.ts

@@ -1,4 +1,4 @@
-// @generated by protoc-gen-es v1.8.0 with parameter "target=ts"
+// @generated by protoc-gen-es v1.9.0 with parameter "target=ts"
 // @generated from file scalekit/v1/organizations/organizations.proto (package scalekit.v1.organizations, syntax proto3)
 /* eslint-disable */
 // @ts-nocheck
@@ -95,7 +95,7 @@ export class CreateOrganization extends Message<CreateOrganization> {
   displayName = "";
 
   /**
-   * Optional regioncode  
+   * Optional regioncode
    *
    * @generated from field: scalekit.v1.commons.RegionCode region_code = 5;
    */
@@ -109,7 +109,7 @@ export class CreateOrganization extends Message<CreateOrganization> {
   externalId?: string;
 
   /**
-   * Key value pairs extension attributes. 
+   * Key value pairs extension attributes.
    *
    * @generated from field: map<string, string> metadata = 7;
    */
@@ -151,14 +151,14 @@ export class CreateOrganization extends Message<CreateOrganization> {
  */
 export class Organization extends Message<Organization> {
   /**
-   * Id 
+   * Id
    *
    * @generated from field: string id = 1;
    */
   id = "";
 
   /**
-   * Created Time 
+   * Created Time
    *
    * @generated from field: google.protobuf.Timestamp create_time = 2;
    */
@@ -179,7 +179,7 @@ export class Organization extends Message<Organization> {
   displayName = "";
 
   /**
-   * Optional regioncode  
+   * Optional regioncode
    *
    * @generated from field: scalekit.v1.commons.RegionCode region_code = 5;
    */
@@ -193,7 +193,7 @@ export class Organization extends Message<Organization> {
   externalId?: string;
 
   /**
-   * Key value pairs extension attributes. 
+   * Key value pairs extension attributes.
    *
    * @generated from field: map<string, string> metadata = 7;
    */
@@ -613,39 +613,113 @@ export class DeleteOrganizationRequest extends Message<DeleteOrganizationRequest
 }
 
 /**
- * @generated from message scalekit.v1.organizations.CustomerPortalLinkRequest
+ * @generated from message scalekit.v1.organizations.GeneratePortalLinkRequest
  */
-export class CustomerPortalLinkRequest extends Message<CustomerPortalLinkRequest> {
+export class GeneratePortalLinkRequest extends Message<GeneratePortalLinkRequest> {
   /**
    * @generated from field: string id = 1;
    */
   id = "";
 
-  constructor(data?: PartialMessage<CustomerPortalLinkRequest>) {
+  constructor(data?: PartialMessage<GeneratePortalLinkRequest>) {
     super();
     proto3.util.initPartial(data, this);
   }
 
   static readonly runtime: typeof proto3 = proto3;
-  static readonly typeName = "scalekit.v1.organizations.CustomerPortalLinkRequest";
+  static readonly typeName = "scalekit.v1.organizations.GeneratePortalLinkRequest";
   static readonly fields: FieldList = proto3.util.newFieldList(() => [
     { no: 1, name: "id", kind: "scalar", T: 9 /* ScalarType.STRING */ },
   ]);
 
-  static fromBinary(bytes: Uint8Array, options?: Partial<BinaryReadOptions>): CustomerPortalLinkRequest {
-    return new CustomerPortalLinkRequest().fromBinary(bytes, options);
+  static fromBinary(bytes: Uint8Array, options?: Partial<BinaryReadOptions>): GeneratePortalLinkRequest {
+    return new GeneratePortalLinkRequest().fromBinary(bytes, options);
   }
 
-  static fromJson(jsonValue: JsonValue, options?: Partial<JsonReadOptions>): CustomerPortalLinkRequest {
-    return new CustomerPortalLinkRequest().fromJson(jsonValue, options);
+  static fromJson(jsonValue: JsonValue, options?: Partial<JsonReadOptions>): GeneratePortalLinkRequest {
+    return new GeneratePortalLinkRequest().fromJson(jsonValue, options);
   }
 
-  static fromJsonString(jsonString: string, options?: Partial<JsonReadOptions>): CustomerPortalLinkRequest {
-    return new CustomerPortalLinkRequest().fromJsonString(jsonString, options);
+  static fromJsonString(jsonString: string, options?: Partial<JsonReadOptions>): GeneratePortalLinkRequest {
+    return new GeneratePortalLinkRequest().fromJsonString(jsonString, options);
   }
 
-  static equals(a: CustomerPortalLinkRequest | PlainMessage<CustomerPortalLinkRequest> | undefined, b: CustomerPortalLinkRequest | PlainMessage<CustomerPortalLinkRequest> | undefined): boolean {
-    return proto3.util.equals(CustomerPortalLinkRequest, a, b);
+  static equals(a: GeneratePortalLinkRequest | PlainMessage<GeneratePortalLinkRequest> | undefined, b: GeneratePortalLinkRequest | PlainMessage<GeneratePortalLinkRequest> | undefined): boolean {
+    return proto3.util.equals(GeneratePortalLinkRequest, a, b);
+  }
+}
+
+/**
+ * @generated from message scalekit.v1.organizations.GetPortalLinkRequest
+ */
+export class GetPortalLinkRequest extends Message<GetPortalLinkRequest> {
+  /**
+   * @generated from field: string id = 1;
+   */
+  id = "";
+
+  constructor(data?: PartialMessage<GetPortalLinkRequest>) {
+    super();
+    proto3.util.initPartial(data, this);
+  }
+
+  static readonly runtime: typeof proto3 = proto3;
+  static readonly typeName = "scalekit.v1.organizations.GetPortalLinkRequest";
+  static readonly fields: FieldList = proto3.util.newFieldList(() => [
+    { no: 1, name: "id", kind: "scalar", T: 9 /* ScalarType.STRING */ },
+  ]);
+
+  static fromBinary(bytes: Uint8Array, options?: Partial<BinaryReadOptions>): GetPortalLinkRequest {
+    return new GetPortalLinkRequest().fromBinary(bytes, options);
+  }
+
+  static fromJson(jsonValue: JsonValue, options?: Partial<JsonReadOptions>): GetPortalLinkRequest {
+    return new GetPortalLinkRequest().fromJson(jsonValue, options);
+  }
+
+  static fromJsonString(jsonString: string, options?: Partial<JsonReadOptions>): GetPortalLinkRequest {
+    return new GetPortalLinkRequest().fromJsonString(jsonString, options);
+  }
+
+  static equals(a: GetPortalLinkRequest | PlainMessage<GetPortalLinkRequest> | undefined, b: GetPortalLinkRequest | PlainMessage<GetPortalLinkRequest> | undefined): boolean {
+    return proto3.util.equals(GetPortalLinkRequest, a, b);
+  }
+}
+
+/**
+ * @generated from message scalekit.v1.organizations.DeletePortalLinkRequest
+ */
+export class DeletePortalLinkRequest extends Message<DeletePortalLinkRequest> {
+  /**
+   * @generated from field: string id = 1;
+   */
+  id = "";
+
+  constructor(data?: PartialMessage<DeletePortalLinkRequest>) {
+    super();
+    proto3.util.initPartial(data, this);
+  }
+
+  static readonly runtime: typeof proto3 = proto3;
+  static readonly typeName = "scalekit.v1.organizations.DeletePortalLinkRequest";
+  static readonly fields: FieldList = proto3.util.newFieldList(() => [
+    { no: 1, name: "id", kind: "scalar", T: 9 /* ScalarType.STRING */ },
+  ]);
+
+  static fromBinary(bytes: Uint8Array, options?: Partial<BinaryReadOptions>): DeletePortalLinkRequest {
+    return new DeletePortalLinkRequest().fromBinary(bytes, options);
+  }
+
+  static fromJson(jsonValue: JsonValue, options?: Partial<JsonReadOptions>): DeletePortalLinkRequest {
+    return new DeletePortalLinkRequest().fromJson(jsonValue, options);
+  }
+
+  static fromJsonString(jsonString: string, options?: Partial<JsonReadOptions>): DeletePortalLinkRequest {
+    return new DeletePortalLinkRequest().fromJsonString(jsonString, options);
+  }
+
+  static equals(a: DeletePortalLinkRequest | PlainMessage<DeletePortalLinkRequest> | undefined, b: DeletePortalLinkRequest | PlainMessage<DeletePortalLinkRequest> | undefined): boolean {
+    return proto3.util.equals(DeletePortalLinkRequest, a, b);
   }
 }
 
@@ -699,76 +773,76 @@ export class Link extends Message<Link> {
 }
 
 /**
- * @generated from message scalekit.v1.organizations.GenerateCustomerPortalLinkResponse
+ * @generated from message scalekit.v1.organizations.GeneratePortalLinkResponse
  */
-export class GenerateCustomerPortalLinkResponse extends Message<GenerateCustomerPortalLinkResponse> {
+export class GeneratePortalLinkResponse extends Message<GeneratePortalLinkResponse> {
   /**
    * @generated from field: scalekit.v1.organizations.Link link = 1;
    */
   link?: Link;
 
-  constructor(data?: PartialMessage<GenerateCustomerPortalLinkResponse>) {
+  constructor(data?: PartialMessage<GeneratePortalLinkResponse>) {
     super();
     proto3.util.initPartial(data, this);
   }
 
   static readonly runtime: typeof proto3 = proto3;
-  static readonly typeName = "scalekit.v1.organizations.GenerateCustomerPortalLinkResponse";
+  static readonly typeName = "scalekit.v1.organizations.GeneratePortalLinkResponse";
   static readonly fields: FieldList = proto3.util.newFieldList(() => [
     { no: 1, name: "link", kind: "message", T: Link },
   ]);
 
-  static fromBinary(bytes: Uint8Array, options?: Partial<BinaryReadOptions>): GenerateCustomerPortalLinkResponse {
-    return new GenerateCustomerPortalLinkResponse().fromBinary(bytes, options);
+  static fromBinary(bytes: Uint8Array, options?: Partial<BinaryReadOptions>): GeneratePortalLinkResponse {
+    return new GeneratePortalLinkResponse().fromBinary(bytes, options);
   }
 
-  static fromJson(jsonValue: JsonValue, options?: Partial<JsonReadOptions>): GenerateCustomerPortalLinkResponse {
-    return new GenerateCustomerPortalLinkResponse().fromJson(jsonValue, options);
+  static fromJson(jsonValue: JsonValue, options?: Partial<JsonReadOptions>): GeneratePortalLinkResponse {
+    return new GeneratePortalLinkResponse().fromJson(jsonValue, options);
   }
 
-  static fromJsonString(jsonString: string, options?: Partial<JsonReadOptions>): GenerateCustomerPortalLinkResponse {
-    return new GenerateCustomerPortalLinkResponse().fromJsonString(jsonString, options);
+  static fromJsonString(jsonString: string, options?: Partial<JsonReadOptions>): GeneratePortalLinkResponse {
+    return new GeneratePortalLinkResponse().fromJsonString(jsonString, options);
   }
 
-  static equals(a: GenerateCustomerPortalLinkResponse | PlainMessage<GenerateCustomerPortalLinkResponse> | undefined, b: GenerateCustomerPortalLinkResponse | PlainMessage<GenerateCustomerPortalLinkResponse> | undefined): boolean {
-    return proto3.util.equals(GenerateCustomerPortalLinkResponse, a, b);
+  static equals(a: GeneratePortalLinkResponse | PlainMessage<GeneratePortalLinkResponse> | undefined, b: GeneratePortalLinkResponse | PlainMessage<GeneratePortalLinkResponse> | undefined): boolean {
+    return proto3.util.equals(GeneratePortalLinkResponse, a, b);
   }
 }
 
 /**
- * @generated from message scalekit.v1.organizations.CustomerPortalLinksResponse
+ * @generated from message scalekit.v1.organizations.GetPortalLinksResponse
  */
-export class CustomerPortalLinksResponse extends Message<CustomerPortalLinksResponse> {
+export class GetPortalLinksResponse extends Message<GetPortalLinksResponse> {
   /**
    * @generated from field: repeated scalekit.v1.organizations.Link links = 1;
    */
   links: Link[] = [];
 
-  constructor(data?: PartialMessage<CustomerPortalLinksResponse>) {
+  constructor(data?: PartialMessage<GetPortalLinksResponse>) {
     super();
     proto3.util.initPartial(data, this);
   }
 
   static readonly runtime: typeof proto3 = proto3;
-  static readonly typeName = "scalekit.v1.organizations.CustomerPortalLinksResponse";
+  static readonly typeName = "scalekit.v1.organizations.GetPortalLinksResponse";
   static readonly fields: FieldList = proto3.util.newFieldList(() => [
     { no: 1, name: "links", kind: "message", T: Link, repeated: true },
   ]);
 
-  static fromBinary(bytes: Uint8Array, options?: Partial<BinaryReadOptions>): CustomerPortalLinksResponse {
-    return new CustomerPortalLinksResponse().fromBinary(bytes, options);
+  static fromBinary(bytes: Uint8Array, options?: Partial<BinaryReadOptions>): GetPortalLinksResponse {
+    return new GetPortalLinksResponse().fromBinary(bytes, options);
   }
 
-  static fromJson(jsonValue: JsonValue, options?: Partial<JsonReadOptions>): CustomerPortalLinksResponse {
-    return new CustomerPortalLinksResponse().fromJson(jsonValue, options);
+  static fromJson(jsonValue: JsonValue, options?: Partial<JsonReadOptions>): GetPortalLinksResponse {
+    return new GetPortalLinksResponse().fromJson(jsonValue, options);
   }
 
-  static fromJsonString(jsonString: string, options?: Partial<JsonReadOptions>): CustomerPortalLinksResponse {
-    return new CustomerPortalLinksResponse().fromJsonString(jsonString, options);
+  static fromJsonString(jsonString: string, options?: Partial<JsonReadOptions>): GetPortalLinksResponse {
+    return new GetPortalLinksResponse().fromJsonString(jsonString, options);
   }
 
-  static equals(a: CustomerPortalLinksResponse | PlainMessage<CustomerPortalLinksResponse> | undefined, b: CustomerPortalLinksResponse | PlainMessage<CustomerPortalLinksResponse> | undefined): boolean {
-    return proto3.util.equals(CustomerPortalLinksResponse, a, b);
+  static equals(a: GetPortalLinksResponse | PlainMessage<GetPortalLinksResponse> | undefined, b: GetPortalLinksResponse | PlainMessage<GetPortalLinksResponse> | undefined): boolean {
+    return proto3.util.equals(GetPortalLinksResponse, a, b);
   }
 }
 

package/src/scalekit.ts

@@ -6,8 +6,8 @@ import { IdTokenClaimToUserMap } from './constants/user';
 import CoreClient from './core';
 import DomainClient from './domain';
 import OrganizationClient from './organization';
-import { AuthorizationUrlOptions, CodeAuthenticationOptions, GrantType } from './types/scalekit';
-import { IdTokenClaim, User } from './types/user';
+import { AuthorizationUrlOptions, AuthenticationOptions, GrantType, AuthenticationResponse } from './types/scalekit';
+import { IdTokenClaim, User } from './types/auth';
 
 const authorizeEndpoint = "oauth/authorize";
 
@@ -16,11 +16,11 @@ const authorizeEndpoint = "oauth/authorize";
  * @param {string} envUrl The environment url
  * @param {string} clientId The client id
  * @param {string} clientSecret The client secret
- * @returns {Scalekit} Returns the scalekit instance 
+ * @returns {ScalekitClient} Returns the scalekit instance 
  * @example
  * const scalekit = new Scalekit(envUrl, clientId, clientSecret);
 */
-export default class Scalekit {
+export default class ScalekitClient {
   private readonly coreClient: CoreClient;
   private readonly grpcConnect: GrpcConnect;
   readonly organization: OrganizationClient;
@@ -65,6 +65,8 @@ export default class Scalekit {
    * @param {string} options.domainHint Domain hint parameter
    * @param {string} options.connectionId Connection id parameter
    * @param {string} options.organizationId Organization id parameter
+   * @param {string} options.codeChallenge Code challenge parameter in case of PKCE
+   * @param {string} options.codeChallengeMethod Code challenge method parameter in case of PKCE
    * 
    * @example
    * const scalekit = new Scalekit(envUrl, clientId, clientSecret);
@@ -76,7 +78,7 @@ export default class Scalekit {
     options?: AuthorizationUrlOptions
   ): string {
     const defaultOptions: AuthorizationUrlOptions = {
-      scopes: ['openid', 'profile']
+      scopes: ['openid', 'profile', 'email']
     }
     options = {
       ...defaultOptions,
@@ -94,6 +96,8 @@ export default class Scalekit {
       ...(options.domainHint && { domain: options.domainHint }),
       ...(options.connectionId && { connection_id: options.connectionId }),
       ...(options.organizationId && { organization_id: options.organizationId }),
+      ...(options.codeChallenge && { code_challenge: options.codeChallenge }),
+      ...(options.codeChallengeMethod && { code_challenge_method: options.codeChallengeMethod })
     })
 
     return `${this.coreClient.envUrl}/${authorizeEndpoint}?${qs}`
@@ -101,24 +105,28 @@ export default class Scalekit {
 
   /**
    * Authenticate with the code
-   * @param {CodeAuthenticationOptions} options Code authentication options
-   * @param {string} options.code Code
-   * @param {string} options.redirectUri Redirect uri
-   * @param {string} options.codeVerifier Code verifier
-   * @returns {Promise<{ user: Partial<User>, idToken: string, accessToken: string }>} Returns user, id token and access token
+   * @param {string} code Code
+   * @param {string} redirectUri Redirect uri
+   * @param {AuthenticationOptions} options Code authentication options
+   * @param {string} options.codeVerifier Code verifier in case of PKCE
+   * @returns {Promise<AuthenticationResponse>} Returns user, id token and access token
    */
-  async authenticateWithCode(options: CodeAuthenticationOptions): Promise<{ user: Partial<User>; idToken: string; accessToken: string; }> {
+  async authenticateWithCode(
+    code: string,
+    redirectUri: string,
+    options?: AuthenticationOptions,
+  ): Promise<AuthenticationResponse> {
     const res = await this.coreClient.authenticate(QueryString.stringify({
-      code: options.code,
-      redirect_uri: options.redirectUri,
+      code: code,
+      redirect_uri: redirectUri,
       grant_type: GrantType.AuthorizationCode,
       client_id: this.coreClient.clientId,
       client_secret: this.coreClient.clientSecret,
-      ...(options.codeVerifier && { code_verifier: options.codeVerifier })
+      ...(options?.codeVerifier && { code_verifier: options.codeVerifier })
     }))
-    const { id_token, access_token } = res.data;
+    const { id_token, access_token, expires_in } = res.data;
     const claims = jose.decodeJwt<IdTokenClaim>(id_token);
-    const user: Partial<User> = {};
+    const user = <User>{};
     for (const [k, v] of Object.entries(claims)) {
       if (IdTokenClaimToUserMap[k]) {
         user[IdTokenClaimToUserMap[k]] = v;
@@ -128,7 +136,8 @@ export default class Scalekit {
     return {
       user,
       idToken: id_token,
-      accessToken: access_token
+      accessToken: access_token,
+      expiresIn: expires_in
     }
   }
 

package/src/types/{user.ts → auth.ts}

@@ -56,4 +56,10 @@ export type IdTokenClaim = {
   updated_at: string | undefined;
   identities: IdTokenClaimIdentity[];
   metadata: string | undefined;
+}
+
+export type TokenResponse = {
+  access_token: string;
+  id_token: string;
+  expires_in: number;
 }

package/src/types/scalekit.ts

@@ -1,3 +1,5 @@
+import { User } from './auth';
+
 export enum GrantType {
   AuthorizationCode = 'authorization_code',
   RefreshToken = 'refresh_token',
@@ -12,19 +14,17 @@ export type AuthorizationUrlOptions = {
   nonce?: string;
   domainHint?: string;
   loginHint?: string;
+  codeChallenge?: string;
+  codeChallengeMethod?: string;
 }
 
-export type CodeAuthenticationOptions = {
-  code: string;
-  redirectUri: string;
-  codeVerifier?: string;
-}
-
-export type RefreshTokenAuthenticationOptions = {
-  code: string;
-  redirectUri: string;
+export type AuthenticationOptions = {
+  codeVerifier?: string; 
 }
 
-export type AuthenticationOptions = {
-  refreshToken: string;
+export type AuthenticationResponse = {
+  user: User;
+  idToken: string;
+  accessToken: string;
+  expiresIn: number;
 }

package/lib/types/user.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"user.js","sourceRoot":"","sources":["../../src/types/user.ts"],"names":[],"mappings":""}