@supernova-studio/supernova-sdk-beta 0.7.17

package/build/sdk-typescript/src/core/areas/SDKAreaWorkspaces.d.ts

@@ -0,0 +1,230 @@
+import { Acl } from "../../model/acl/SDKAcl";
+import { UserRoleWithoutOwner } from "../../model/enums/SDKUserRole";
+import { Membership } from "../../model/membership/SDKMembership";
+import { UserMembership } from "../../model/users/SDKUserMembership";
+import { Workspace } from "../../model/workspaces/SDKWorkspace";
+import { WorkspaceIPWhitelistSettings, WorkspaceIPWhitelistSettingsUpdateModel } from "../../model/workspaces/SDKWorkspaceIPWhitelistSettings";
+import { WorkspaceInvitation, WorkspaceInvitationUpdateModel } from "../../model/workspaces/SDKWorkspaceInvitation";
+import { WorkspaceInvoice } from "../../model/workspaces/SDKWorkspaceInvoice";
+import { WorkspaceNPMRegistryAccessTokenRemoteModel } from "../../model/workspaces/SDKWorkspaceNPMRegistryAccessToken";
+import { WorkspaceNPMRegistrySettings, WorkspaceNPMRegistrySettingsUpdateModel } from "../../model/workspaces/SDKWorkspaceNPMRegistrySettings";
+import { WorkspaceOnboarding, WorkspaceOnboardingUpdateModel } from "../../model/workspaces/SDKWorkspaceOnboarding";
+import { WorkspaceProduct } from "../../model/workspaces/SDKWorkspaceProduct";
+import { SubscriptionProductFeatures } from "../../model/workspaces/SDKWorkspaceProductFeatures";
+import { WorkspaceProfileUpdateModel } from "../../model/workspaces/SDKWorkspaceProfile";
+import { WorkspaceSSOSettings, WorkspaceSSOSettingsUpdateModel } from "../../model/workspaces/SDKWorkspaceSSOSettings";
+import { WorkspaceSubscription, WorkspaceSubscriptionUpdateModel } from "../../model/workspaces/SDKWorkspaceSubscription";
+import { DataCore } from "../data/SDKDataCore";
+export declare class AreaWorkspaces {
+    /** Internal: Engine */
+    private dataCore;
+    constructor(dataCore: DataCore);
+    /** Fetches one specific workspace by provided id
+     * @param workspaceId - ID of the workspace
+     * @returns Full workspace object
+     */
+    workspace(workspaceId: string): Promise<Workspace>;
+    /** Fetches all workspaces user has access to. Use `memberships` instead if you want to also know which role the current user has in which workspace
+     * @param userId - ID of the user
+     * @returns All workspaces user is part of
+     */
+    workspaces(userId: string): Promise<Array<Workspace>>;
+    /** Fetches all memberships user is part of. Each memberships contains workspace and user role.
+     * @param userId - ID of the user
+     * @returns All workspaces user is part of
+     */
+    memberships(userId: string): Promise<Array<Membership>>;
+    /** Fetches all users that are part of the workspace. Each user contains user role as well.
+     * @param workspaceId - ID of the workspace
+     * @returns All users that are members of the provided workspace
+     */
+    userMemberships(workspaceId: string): Promise<Array<UserMembership>>;
+    /** Fetches product features grouped by product code
+     * @param workspaceId - ID of the workspace
+     * @returns Product features
+     */
+    workspaceProductFeatures(workspaceId: string): Promise<SubscriptionProductFeatures>;
+    acls(): Promise<Acl>;
+    /** Validates if the handle is available for use
+     * @param handle - Handle to validate
+     * @returns True if the handle is available (not occupied by any other workspace), false otherwise
+     */
+    validateIsWorkspaceHandleAvailable(handle: string): Promise<boolean>;
+    /** Fetches workspace onboarding status
+     * @param workspaceId - ID of the workspace
+     * @returns Workspace onboarding status
+     */
+    workspaceOnboarding(workspaceId: string): Promise<WorkspaceOnboarding>;
+    /** Fetches workspace IP whitelist settings
+     * @param workspaceId - ID of the workspace
+     * @returns Workspace IP whitelist settings or null if the workspace is not using IP whitelist
+     */
+    workspaceIPWhitelistSettings(workspaceId: string): Promise<WorkspaceIPWhitelistSettings | null>;
+    /** Fetches workspace NPM registry settings
+     * @param workspaceId - ID of the workspace
+     * @returns Workspace NPM registry settings or null if the workspace is not using NPM registry
+     */
+    workspaceNPMRegistrySettings(workspaceId: string): Promise<WorkspaceNPMRegistrySettings | null>;
+    /** Fetches workspace NPM registry access token
+     * @param workspaceId - ID of the workspace
+     * @returns Workspace NPM registry access token
+     */
+    workspaceNPMRegistryAccessToken(workspaceId: string): Promise<WorkspaceNPMRegistryAccessTokenRemoteModel | null>;
+    /** Fetches workspace SSO settings
+     * @param workspaceId - ID of the workspace
+     * @returns Workspace SSO settings or null if the workspace is not using SSO
+     */
+    workspaceSSOSettings(workspaceId: string): Promise<WorkspaceSSOSettings | null>;
+    /** Fetches all invitations that are part of the workspace.
+     * @param workspaceId - ID of the workspace
+     * @returns All invitations of the provided workspace
+     */
+    workspaceInvitations(workspaceId: string): Promise<Array<WorkspaceInvitation>>;
+    /** Fetches all invoices for the workspace.
+     * @param workspaceId - ID of the workspace
+     * @returns All invoices of the provided workspace
+     */
+    workspaceInvoices(workspaceId: string): Promise<Array<WorkspaceInvoice>>;
+    /** Fetches a subscription of the workspace.
+     * @param workspaceId - ID of the workspace
+     * @returns A subscription of the provided workspace
+     */
+    workspaceSubscription(workspaceId: string): Promise<WorkspaceSubscription>;
+    /** Fetches all products that are available to the workspace.
+     * @param workspaceId - ID of the workspace
+     * @returns All available products
+     */
+    workspaceAvailableProducts(workspaceId: string): Promise<Array<WorkspaceProduct>>;
+    /** Creates new workspace and retrieves the newly created workspace object. The user who creates the workspace becomes its owner
+     * @param name - Name of the workspace
+     * @param handle - Handle of the workspace to create. Use `validateIsWorkspaceHandleAvailable` to check if the handle is available
+     * @returns Newly created workspace object
+     */
+    createWorkspace(name: string, handle?: string): Promise<Workspace>;
+    /** Updates workspace profile for a specific workspace
+     * @param workspaceId - ID of the workspace
+     * @param update - New profile data
+     * @returns Nothing
+     */
+    updateWorkspaceProfile(workspaceId: string, update: WorkspaceProfileUpdateModel): Promise<void>;
+    /** tests accessibility of IP allowlist settings
+     * @param workspaceId - ID of the workspace
+     * @param ipWhitelistSettings - settings to test
+     * @returns information if workspace is accesible by your IP
+     */
+    testIpWhitelistSettings(workspaceId: string, ipWhitelistSettings: WorkspaceIPWhitelistSettingsUpdateModel): Promise<{
+        accessible: boolean;
+    }>;
+    /** Updates workspace onboarding state for a specific workspace
+     * @param workspaceId - ID of the workspace
+     * @param update - New onboarding state
+     * @returns Nothing
+     */
+    updateWorkspaceOnboarding(workspaceId: string, update: WorkspaceOnboardingUpdateModel): Promise<void>;
+    /** Updates workspace avatar for a specific workspace
+     * @param workspaceId - ID of the workspace
+     * @param avatar - New avatar
+     * @returns Nothing
+     */
+    updateWorkspaceAvatar(workspaceId: string, avatar: File): Promise<void>;
+    /** Updates workspace SSO settings for a specific workspace
+     * @param workspaceId - ID of the workspace
+     * @param profile - New SSO configuration
+     * @returns Nothing
+     */
+    updateWorkspaceSSOSettings(workspaceId: string, update: WorkspaceSSOSettingsUpdateModel): Promise<void>;
+    /** Updates workspace IP whitelist settings for a specific workspace
+     * @param workspaceId - ID of the workspace
+     * @param profile - New IP whitelist configuration
+     * @returns Nothing
+     */
+    updateWorkspaceIPWhitelistSettings(workspaceId: string, ipWhitelistSettings: WorkspaceIPWhitelistSettingsUpdateModel): Promise<void>;
+    /** Updates workspace NPM registry settings for a specific workspace
+     * @param workspaceId - ID of the workspace
+     * @param profile - New NPM registry configuration
+     * @returns Nothing
+     */
+    updateWorkspaceNPMRegistrySettings(workspaceId: string, npmRegistrySettings: WorkspaceNPMRegistrySettingsUpdateModel): Promise<void>;
+    /** Transfers an ownership of the workspace.
+     * Old owner receives new owner's previous role.
+     * @param workspaceId - ID of the workspace
+     * @param newOwnerUserId - ID of the user to transfer the ownership to
+     * @returns Nothing
+     */
+    updateWorkspaceOwnership(workspaceId: string, newOwnerUserId: string): Promise<void>;
+    /** Updates a role of a member.
+     * @param workspaceId - ID of the workspace
+     * @param userId - ID of the user
+     * @param newRole - New role of the user
+     * @returns Nothing
+     */
+    updateWorkspaceMemberRole(workspaceId: string, userId: string, newRole: UserRoleWithoutOwner): Promise<void>;
+    /** Updates a role of an invitation.
+     * @param workspaceId - ID of the workspace
+     * @param invitationId - ID of the invitation
+     * @param newRole - New role
+     * @returns Nothing
+     */
+    updateWorkspaceInvitationRole(workspaceId: string, invitationId: string, newRole: UserRoleWithoutOwner): Promise<void>;
+    /** Invites new members to the workspace
+     * @param workspaceId - ID of the workspace
+     * @param invitations - array of invitations
+     * @returns Nothing
+     */
+    addWorkspaceInvitations(workspaceId: string, invitations: Array<WorkspaceInvitationUpdateModel>): Promise<void>;
+    /** Creates a new Stripe checkout session.
+     * @param workspaceId - ID of the workspace
+     * @param priceId - ID of the Stripe price to be applied to the workspace
+     * @param successUrl - URL to redirect to after successful payment
+     * @param cancelUrl - URL to redirect to after failed payment
+     * @param quantity - number of seats to be pre-selected in the checkout
+     * @returns string - URL to the Stripe checkout
+     */
+    createCheckoutSession(workspaceId: string, priceId: string, successUrl: string, cancelUrl: string, quantity?: number | null): Promise<string>;
+    /** Creates a new Stripe customer portal session.
+     * @param workspaceId - ID of the workspace
+     * @param returnUrl - URL to redirect to from the portal
+     * @param update - describes the subscription updates to be applied
+     * @param cancel - describes if the subscription must be cancelled
+     * @returns string - URL to the Stripe customer portal
+     */
+    createPortalSession(workspaceId: string, returnUrl: string, update?: WorkspaceSubscriptionUpdateModel | null, cancel?: boolean | null): Promise<string>;
+    /** Resend an invitation to the workspace.
+     * @param workspaceId - ID of the workspace
+     * @param invitationId - ID of the invitation
+     * @returns Nothing
+     */
+    resendWorkspaceInvitation(workspaceId: string, invitationId: string): Promise<void>;
+    /** Restore a cancelled workspace subscription.
+     * @param workspaceId - ID of the workspace
+     * @returns Nothing
+     */
+    restoreWorkspaceSubscription(workspaceId: string): Promise<void>;
+    /** Deletes a single workspace. This action is irreversible, all data will be lost, and can only be performed by the workspace owner
+     * @param workspaceId - ID of the workspace
+     * @returns Nothing
+     */
+    deleteWorkspace(workspaceId: string): Promise<void>;
+    /** Deletes workspace avatar. This action is irreversible
+     * @param workspaceId - ID of the workspace
+     * @returns Nothing
+     */
+    deleteWorkspaceAvatar(workspaceId: string): Promise<void>;
+    /** Deletes a workspace registry settings for a specific workspace
+     * @param workspaceId - ID of the workspace
+     * @returns Nothing
+     */
+    deleteWorkspaceNPMRegistrySettings(workspaceId: string): Promise<void>;
+    /** Deletes a member from the workspace.
+     * @param workspaceId - ID of the workspace
+     * @param userId - ID of the member
+     * @returns Nothing
+     */
+    deleteWorkspaceMember(workspaceId: string, userId: string): Promise<void>;
+    /** Deletes an invitation from the workspace.
+     * @param workspaceId - ID of the workspace
+     * @param invitationId - ID of the invitation
+     * @returns Nothing
+     */
+    deleteWorkspaceInvitation(workspaceId: string, invitationId: string): Promise<void>;
+}

package/build/sdk-typescript/src/core/areas/SDKRemoteIdentifiers.d.ts

@@ -0,0 +1,25 @@
+/** Unique, full identification of a single Supernova version including the workspace */
+export type RemoteWorkspaceVersionIdentifier = {
+    /** Workspace ID */
+    workspaceId: string;
+    /** Design system ID */
+    designSystemId: string;
+    /** Version ID */
+    versionId: string;
+};
+/** Unique, full identification of a single Supernova version */
+export type RemoteVersionIdentifier = {
+    /** Design system ID */
+    designSystemId: string;
+    /** Version ID */
+    versionId: string;
+};
+/** Unique, full identification of a single Supernova brand */
+export type RemoteBrandIdentifier = {
+    /** Design system ID */
+    designSystemId: string;
+    /** Version ID */
+    versionId: string;
+    /** Brand ID */
+    brandId: string;
+};

package/build/sdk-typescript/src/core/data/SDKConfiguration.d.ts

@@ -0,0 +1,6 @@
+export declare class Configuration {
+    /** Retrieve API URL for default target */
+    static apiUrlForDefaultEnvironment(): string;
+    /** Retrieve API version for the specific environment accesse */
+    static apiVersionForDefaultEnvironment(): string;
+}

package/build/sdk-typescript/src/core/data/SDKDataBridge.d.ts

@@ -0,0 +1,55 @@
+import { HttpsProxyAgent } from "https-proxy-agent";
+type DataBridgeRequestHookResult = {
+    skipDefaultAuth?: boolean;
+};
+export type DataBridgeRequestHook = (request: any) => void | DataBridgeRequestHookResult | Promise<void | DataBridgeRequestHookResult>;
+export type DebugResponseObserver = (info: {
+    requestUrl: string;
+    response: any;
+    executionTime: number;
+    error?: Error;
+}) => void;
+export type DebugRequestObserver = (info: {
+    requestUrl: string;
+    requestMethod: string;
+}) => void;
+export type DataBridgeConfiguration = {
+    apiUrl: string;
+    apiVersion: string;
+    accessToken: string;
+    target: string | null;
+    bypassEnvFetch: boolean;
+    requestHook: DataBridgeRequestHook | null;
+    debugRequestObserver?: DebugRequestObserver | null;
+    debugResponseObserver?: DebugResponseObserver | null;
+    proxyUrl?: string | null;
+};
+export declare class DataBridge {
+    authToken: string;
+    apiUrl: string;
+    apiVersion: string;
+    target: string | null;
+    bypassEnvFetch: boolean;
+    proxyAgent: HttpsProxyAgent<string> | undefined;
+    requestHook: DataBridgeRequestHook | null;
+    debugRequestObserver: DebugRequestObserver | null;
+    debugResponseObserver: DebugResponseObserver | null;
+    constructor(conf: DataBridgeConfiguration);
+    delete(endpoint: string): Promise<any>;
+    get(endpoint: string): Promise<any>;
+    getAsData(endpoint: string): Promise<any>;
+    put(endpoint: string, payload: any | null): Promise<any>;
+    post(endpoint: string, payload: any | null): Promise<any>;
+    upload(endpoint: string, formData: FormData, method?: "PUT" | "POST"): Promise<any>;
+    private request;
+    private handleResponse;
+    private buildRequestConfig;
+    getBaseEndpoint(fragment: string | null): string;
+    getPublicEndpoint(fragment: string): string;
+    getAclEndpoint(resource?: string): string;
+    getUserEndpoint(userId: string, fragment: string | null): string;
+    getWorkspaceEndpoint(wsId: string, fragment: string | null): string;
+    getDesignSystemEndpoint(dsId: string, fragment: string | null): string;
+    getVersionEndpoint(dsId: string, dsVersionId: string, fragment: string | null): string;
+}
+export {};