@approvio/ts-sdk 0.0.8 → 0.0.10

package/dist/index.d.cts

@@ -0,0 +1,148 @@
+import { AxiosInstance } from "axios";
+import { APIError, AddGroupEntitiesRequest, AgentGet200Response, AgentRegistrationRequest, AgentRegistrationResponse, AgentTokenResponse, CanVoteResponse, GetEntityInfo200Response, GetWorkflowParams, Group, GroupCreate, ListGroupEntities200Response, ListGroups200Response, ListOrganizationAdminsForOrg200Response, ListRoleTemplates200Response, ListSpaces200Response, ListUsers200Response, ListWorkflowTemplates200Response, ListWorkflows200Response, ListWorkflowsParams, OrganizationAdminCreate, OrganizationAdminRemove, RemoveGroupEntitiesRequest, RoleAssignmentRequest, RoleRemovalRequest, Space, SpaceCreate, TokenResponse, User, UserCreate, Workflow, WorkflowCreate, WorkflowTemplate, WorkflowTemplateCreate, WorkflowTemplateDeprecate, WorkflowTemplateUpdate, WorkflowVoteRequest } from "@approvio/api";
+import * as TE from "fp-ts/TaskEither.js";
+
+//#region src/interfaces.d.ts
+interface Authenticator {
+  customizeAxios(axios: AxiosInstance): void;
+}
+interface TokenBaseAuthenticator extends Authenticator {
+  getAccessToken(): Promise<string>;
+}
+interface ApprovioServerConfig {
+  endpoint: string;
+}
+//#endregion
+//#region src/auth/user.authenticator.d.ts
+declare class CliUserAuthenticator implements TokenBaseAuthenticator {
+  private accessToken;
+  private refreshToken;
+  private readonly onTokenRefreshed?;
+  private readonly endpoint;
+  constructor(endpoint: string, accessToken: string, refreshToken: string, onTokenRefreshed?: ((accessToken: string, refreshToken: string) => void) | undefined);
+  customizeAxios(axios: AxiosInstance): void;
+  getAccessToken(): Promise<string>;
+  private isTokenExpired;
+  private renewToken;
+}
+//#endregion
+//#region src/auth/web.authenticator.d.ts
+declare class WebAuthenticator implements Authenticator {
+  customizeAxios(axios: AxiosInstance): void;
+}
+//#endregion
+//#region src/client/base.client.d.ts
+type ApprovioError = (APIError & {
+  status: number;
+}) | Error;
+declare abstract class BaseApprovioClient {
+  protected readonly config: ApprovioServerConfig;
+  protected readonly authenticator: Authenticator;
+  protected readonly axios: AxiosInstance;
+  constructor(config: ApprovioServerConfig, authenticator: Authenticator);
+  protected handleError(error: unknown): ApprovioError;
+  protected get<T>(url: string, params?: Record<string, unknown>): TE.TaskEither<ApprovioError, T>;
+  protected post<T>(url: string, data?: unknown): TE.TaskEither<ApprovioError, T>;
+  protected postWithLocation<T>(url: string, data?: unknown): TE.TaskEither<ApprovioError, {
+    data: T;
+    location: string;
+  }>;
+  protected put<T>(url: string, data?: unknown): TE.TaskEither<ApprovioError, T>;
+  protected delete<T>(url: string, data?: unknown): TE.TaskEither<ApprovioError, T>;
+  getWorkflow(workflowId: string, params?: GetWorkflowParams): TE.TaskEither<ApprovioError, Workflow>;
+  listWorkflows(params?: ListWorkflowsParams): TE.TaskEither<ApprovioError, ListWorkflows200Response>;
+  createWorkflow(data: WorkflowCreate): TE.TaskEither<ApprovioError, void>;
+  voteOnWorkflow(workflowId: string, data: WorkflowVoteRequest): TE.TaskEither<ApprovioError, unknown>;
+  canVoteOnWorkflow(workflowId: string): TE.TaskEither<ApprovioError, CanVoteResponse>;
+  listRoleTemplates(): TE.TaskEither<ApprovioError, ListRoleTemplates200Response>;
+  getEntityInfo(): TE.TaskEither<ApprovioError, GetEntityInfo200Response>;
+}
+//#endregion
+//#region src/auth/auth.helpers.d.ts
+declare class AuthHelper {
+  private readonly endpoint;
+  constructor(endpoint: string);
+  getUserLoginUrl(): string;
+  initiateCliLogin(redirectUri: string): TE.TaskEither<ApprovioError, string>;
+  exchangeTokenForUser(code: string, state: string): TE.TaskEither<ApprovioError, TokenResponse>;
+  authenticateAgent(agentName: string, privateKeyPem: string): TE.TaskEither<ApprovioError, AgentTokenResponse>;
+  protected handleError(error: unknown): ApprovioError;
+}
+//#endregion
+//#region src/auth/agent.authenticator.d.ts
+declare class AgentAuthenticator implements TokenBaseAuthenticator {
+  private readonly privateKey;
+  private accessToken;
+  private refreshToken;
+  private readonly onTokenRefreshed?;
+  private readonly endpoint;
+  constructor(endpoint: string, privateKey: string, accessToken: string, refreshToken: string, onTokenRefreshed?: ((accessToken: string, refreshToken: string) => void) | undefined);
+  customizeAxios(axios: AxiosInstance): void;
+  getAccessToken(): Promise<string>;
+  private renewToken;
+  private generateDpopProof;
+}
+//#endregion
+//#region src/client/user.client.d.ts
+declare class ApprovioUserClient extends BaseApprovioClient {
+  readonly authenticator: CliUserAuthenticator | WebAuthenticator;
+  constructor(config: ApprovioServerConfig, authenticator: CliUserAuthenticator | WebAuthenticator);
+  listUsers(params?: {
+    search?: string;
+    page?: number;
+    limit?: number;
+  }): TE.TaskEither<ApprovioError, ListUsers200Response>;
+  registerAgent(data: AgentRegistrationRequest): TE.TaskEither<ApprovioError, AgentRegistrationResponse>;
+  assignAgentRoles(agentId: string, data: RoleAssignmentRequest): TE.TaskEither<ApprovioError, void>;
+  removeAgentRoles(agentId: string, data: RoleRemovalRequest): TE.TaskEither<ApprovioError, void>;
+  createUser(data: UserCreate): TE.TaskEither<ApprovioError, string>;
+  getUser(userId: string): TE.TaskEither<ApprovioError, User>;
+  assignUserRoles(userId: string, data: RoleAssignmentRequest): TE.TaskEither<ApprovioError, void>;
+  removeUserRoles(userId: string, data: RoleRemovalRequest): TE.TaskEither<ApprovioError, void>;
+  createWorkflowTemplate(data: WorkflowTemplateCreate): TE.TaskEither<ApprovioError, WorkflowTemplate>;
+  listWorkflowTemplates(params?: {
+    page?: number;
+    limit?: number;
+  }): TE.TaskEither<ApprovioError, ListWorkflowTemplates200Response>;
+  getWorkflowTemplate(templateIdentifier: string): TE.TaskEither<ApprovioError, WorkflowTemplate>;
+  updateWorkflowTemplate(templateIdentifier: string, data: WorkflowTemplateUpdate): TE.TaskEither<ApprovioError, WorkflowTemplate>;
+  deprecateWorkflowTemplate(templateName: string, data?: WorkflowTemplateDeprecate): TE.TaskEither<ApprovioError, WorkflowTemplate>;
+  createGroup(data: GroupCreate): TE.TaskEither<ApprovioError, string>;
+  listGroups(params?: {
+    page?: number;
+    limit?: number;
+  }): TE.TaskEither<ApprovioError, ListGroups200Response>;
+  getGroup(groupIdentifier: string): TE.TaskEither<ApprovioError, Group>;
+  listGroupEntities(groupId: string, params?: {
+    page?: number;
+    limit?: number;
+  }): TE.TaskEither<ApprovioError, ListGroupEntities200Response>;
+  addGroupEntities(groupId: string, data: AddGroupEntitiesRequest): TE.TaskEither<ApprovioError, Group>;
+  removeGroupEntities(groupId: string, data: RemoveGroupEntitiesRequest): TE.TaskEither<ApprovioError, Group>;
+  createSpace(data: SpaceCreate): TE.TaskEither<ApprovioError, void>;
+  listSpaces(params?: {
+    page?: number;
+    limit?: number;
+  }): TE.TaskEither<ApprovioError, ListSpaces200Response>;
+  getSpace(spaceId: string): TE.TaskEither<ApprovioError, Space>;
+  deleteSpace(spaceId: string): TE.TaskEither<ApprovioError, void>;
+  addOrganizationAdminToOrg(organizationName: string, data: OrganizationAdminCreate): TE.TaskEither<ApprovioError, void>;
+  listOrganizationAdminsForOrg(organizationName: string, params?: {
+    page?: number;
+    limit?: number;
+  }): TE.TaskEither<ApprovioError, ListOrganizationAdminsForOrg200Response>;
+  removeOrganizationAdminFromOrg(organizationName: string, data: OrganizationAdminRemove): TE.TaskEither<ApprovioError, void>;
+  getAgent(agentId: string): TE.TaskEither<ApprovioError, AgentGet200Response>;
+}
+//#endregion
+//#region src/client/agent.client.d.ts
+declare class ApprovioAgentClient extends BaseApprovioClient {
+  readonly authenticator: AgentAuthenticator;
+  constructor(config: ApprovioServerConfig, authenticator: AgentAuthenticator);
+  getAuthenticator(): Authenticator;
+}
+//#endregion
+//#region src/client/utils.d.ts
+declare function isApprovioError(data: unknown): data is APIError;
+//#endregion
+export { AgentAuthenticator, ApprovioAgentClient, ApprovioError, ApprovioServerConfig, ApprovioUserClient, AuthHelper, Authenticator, BaseApprovioClient, CliUserAuthenticator, TokenBaseAuthenticator, WebAuthenticator, isApprovioError };

package/dist/index.d.mts

@@ -0,0 +1,148 @@
+import { AxiosInstance } from "axios";
+import { APIError, AddGroupEntitiesRequest, AgentGet200Response, AgentRegistrationRequest, AgentRegistrationResponse, AgentTokenResponse, CanVoteResponse, GetEntityInfo200Response, GetWorkflowParams, Group, GroupCreate, ListGroupEntities200Response, ListGroups200Response, ListOrganizationAdminsForOrg200Response, ListRoleTemplates200Response, ListSpaces200Response, ListUsers200Response, ListWorkflowTemplates200Response, ListWorkflows200Response, ListWorkflowsParams, OrganizationAdminCreate, OrganizationAdminRemove, RemoveGroupEntitiesRequest, RoleAssignmentRequest, RoleRemovalRequest, Space, SpaceCreate, TokenResponse, User, UserCreate, Workflow, WorkflowCreate, WorkflowTemplate, WorkflowTemplateCreate, WorkflowTemplateDeprecate, WorkflowTemplateUpdate, WorkflowVoteRequest } from "@approvio/api";
+import * as TE from "fp-ts/TaskEither.js";
+
+//#region src/interfaces.d.ts
+interface Authenticator {
+  customizeAxios(axios: AxiosInstance): void;
+}
+interface TokenBaseAuthenticator extends Authenticator {
+  getAccessToken(): Promise<string>;
+}
+interface ApprovioServerConfig {
+  endpoint: string;
+}
+//#endregion
+//#region src/auth/user.authenticator.d.ts
+declare class CliUserAuthenticator implements TokenBaseAuthenticator {
+  private accessToken;
+  private refreshToken;
+  private readonly onTokenRefreshed?;
+  private readonly endpoint;
+  constructor(endpoint: string, accessToken: string, refreshToken: string, onTokenRefreshed?: ((accessToken: string, refreshToken: string) => void) | undefined);
+  customizeAxios(axios: AxiosInstance): void;
+  getAccessToken(): Promise<string>;
+  private isTokenExpired;
+  private renewToken;
+}
+//#endregion
+//#region src/auth/web.authenticator.d.ts
+declare class WebAuthenticator implements Authenticator {
+  customizeAxios(axios: AxiosInstance): void;
+}
+//#endregion
+//#region src/client/base.client.d.ts
+type ApprovioError = (APIError & {
+  status: number;
+}) | Error;
+declare abstract class BaseApprovioClient {
+  protected readonly config: ApprovioServerConfig;
+  protected readonly authenticator: Authenticator;
+  protected readonly axios: AxiosInstance;
+  constructor(config: ApprovioServerConfig, authenticator: Authenticator);
+  protected handleError(error: unknown): ApprovioError;
+  protected get<T>(url: string, params?: Record<string, unknown>): TE.TaskEither<ApprovioError, T>;
+  protected post<T>(url: string, data?: unknown): TE.TaskEither<ApprovioError, T>;
+  protected postWithLocation<T>(url: string, data?: unknown): TE.TaskEither<ApprovioError, {
+    data: T;
+    location: string;
+  }>;
+  protected put<T>(url: string, data?: unknown): TE.TaskEither<ApprovioError, T>;
+  protected delete<T>(url: string, data?: unknown): TE.TaskEither<ApprovioError, T>;
+  getWorkflow(workflowId: string, params?: GetWorkflowParams): TE.TaskEither<ApprovioError, Workflow>;
+  listWorkflows(params?: ListWorkflowsParams): TE.TaskEither<ApprovioError, ListWorkflows200Response>;
+  createWorkflow(data: WorkflowCreate): TE.TaskEither<ApprovioError, void>;
+  voteOnWorkflow(workflowId: string, data: WorkflowVoteRequest): TE.TaskEither<ApprovioError, unknown>;
+  canVoteOnWorkflow(workflowId: string): TE.TaskEither<ApprovioError, CanVoteResponse>;
+  listRoleTemplates(): TE.TaskEither<ApprovioError, ListRoleTemplates200Response>;
+  getEntityInfo(): TE.TaskEither<ApprovioError, GetEntityInfo200Response>;
+}
+//#endregion
+//#region src/auth/auth.helpers.d.ts
+declare class AuthHelper {
+  private readonly endpoint;
+  constructor(endpoint: string);
+  getUserLoginUrl(): string;
+  initiateCliLogin(redirectUri: string): TE.TaskEither<ApprovioError, string>;
+  exchangeTokenForUser(code: string, state: string): TE.TaskEither<ApprovioError, TokenResponse>;
+  authenticateAgent(agentName: string, privateKeyPem: string): TE.TaskEither<ApprovioError, AgentTokenResponse>;
+  protected handleError(error: unknown): ApprovioError;
+}
+//#endregion
+//#region src/auth/agent.authenticator.d.ts
+declare class AgentAuthenticator implements TokenBaseAuthenticator {
+  private readonly privateKey;
+  private accessToken;
+  private refreshToken;
+  private readonly onTokenRefreshed?;
+  private readonly endpoint;
+  constructor(endpoint: string, privateKey: string, accessToken: string, refreshToken: string, onTokenRefreshed?: ((accessToken: string, refreshToken: string) => void) | undefined);
+  customizeAxios(axios: AxiosInstance): void;
+  getAccessToken(): Promise<string>;
+  private renewToken;
+  private generateDpopProof;
+}
+//#endregion
+//#region src/client/user.client.d.ts
+declare class ApprovioUserClient extends BaseApprovioClient {
+  readonly authenticator: CliUserAuthenticator | WebAuthenticator;
+  constructor(config: ApprovioServerConfig, authenticator: CliUserAuthenticator | WebAuthenticator);
+  listUsers(params?: {
+    search?: string;
+    page?: number;
+    limit?: number;
+  }): TE.TaskEither<ApprovioError, ListUsers200Response>;
+  registerAgent(data: AgentRegistrationRequest): TE.TaskEither<ApprovioError, AgentRegistrationResponse>;
+  assignAgentRoles(agentId: string, data: RoleAssignmentRequest): TE.TaskEither<ApprovioError, void>;
+  removeAgentRoles(agentId: string, data: RoleRemovalRequest): TE.TaskEither<ApprovioError, void>;
+  createUser(data: UserCreate): TE.TaskEither<ApprovioError, string>;
+  getUser(userId: string): TE.TaskEither<ApprovioError, User>;
+  assignUserRoles(userId: string, data: RoleAssignmentRequest): TE.TaskEither<ApprovioError, void>;
+  removeUserRoles(userId: string, data: RoleRemovalRequest): TE.TaskEither<ApprovioError, void>;
+  createWorkflowTemplate(data: WorkflowTemplateCreate): TE.TaskEither<ApprovioError, WorkflowTemplate>;
+  listWorkflowTemplates(params?: {
+    page?: number;
+    limit?: number;
+  }): TE.TaskEither<ApprovioError, ListWorkflowTemplates200Response>;
+  getWorkflowTemplate(templateIdentifier: string): TE.TaskEither<ApprovioError, WorkflowTemplate>;
+  updateWorkflowTemplate(templateIdentifier: string, data: WorkflowTemplateUpdate): TE.TaskEither<ApprovioError, WorkflowTemplate>;
+  deprecateWorkflowTemplate(templateName: string, data?: WorkflowTemplateDeprecate): TE.TaskEither<ApprovioError, WorkflowTemplate>;
+  createGroup(data: GroupCreate): TE.TaskEither<ApprovioError, string>;
+  listGroups(params?: {
+    page?: number;
+    limit?: number;
+  }): TE.TaskEither<ApprovioError, ListGroups200Response>;
+  getGroup(groupIdentifier: string): TE.TaskEither<ApprovioError, Group>;
+  listGroupEntities(groupId: string, params?: {
+    page?: number;
+    limit?: number;
+  }): TE.TaskEither<ApprovioError, ListGroupEntities200Response>;
+  addGroupEntities(groupId: string, data: AddGroupEntitiesRequest): TE.TaskEither<ApprovioError, Group>;
+  removeGroupEntities(groupId: string, data: RemoveGroupEntitiesRequest): TE.TaskEither<ApprovioError, Group>;
+  createSpace(data: SpaceCreate): TE.TaskEither<ApprovioError, void>;
+  listSpaces(params?: {
+    page?: number;
+    limit?: number;
+  }): TE.TaskEither<ApprovioError, ListSpaces200Response>;
+  getSpace(spaceId: string): TE.TaskEither<ApprovioError, Space>;
+  deleteSpace(spaceId: string): TE.TaskEither<ApprovioError, void>;
+  addOrganizationAdminToOrg(organizationName: string, data: OrganizationAdminCreate): TE.TaskEither<ApprovioError, void>;
+  listOrganizationAdminsForOrg(organizationName: string, params?: {
+    page?: number;
+    limit?: number;
+  }): TE.TaskEither<ApprovioError, ListOrganizationAdminsForOrg200Response>;
+  removeOrganizationAdminFromOrg(organizationName: string, data: OrganizationAdminRemove): TE.TaskEither<ApprovioError, void>;
+  getAgent(agentId: string): TE.TaskEither<ApprovioError, AgentGet200Response>;
+}
+//#endregion
+//#region src/client/agent.client.d.ts
+declare class ApprovioAgentClient extends BaseApprovioClient {
+  readonly authenticator: AgentAuthenticator;
+  constructor(config: ApprovioServerConfig, authenticator: AgentAuthenticator);
+  getAuthenticator(): Authenticator;
+}
+//#endregion
+//#region src/client/utils.d.ts
+declare function isApprovioError(data: unknown): data is APIError;
+//#endregion
+export { AgentAuthenticator, ApprovioAgentClient, ApprovioError, ApprovioServerConfig, ApprovioUserClient, AuthHelper, Authenticator, BaseApprovioClient, CliUserAuthenticator, TokenBaseAuthenticator, WebAuthenticator, isApprovioError };