@burdenoff/microfe-devportal 2026.714.9 → 2026.715.2

package/dist/devportal/types/index.d.ts

@@ -0,0 +1,710 @@
+import { ReactNode } from 'react';
+
+/**
+ * Navigation item for shell integration
+ */
+export interface NavItem {
+    id: string;
+    label: string;
+    path: string;
+    icon?: ReactNode;
+    badge?: number;
+    order?: number;
+    group?: string;
+    visible?: boolean;
+    children?: NavItem[];
+}
+/**
+ * Footer item for shell integration
+ */
+export interface FooterItem {
+    id: string;
+    label: string;
+    type: "status" | "action";
+    order?: number;
+    section: "left" | "center" | "right";
+}
+/**
+ * Props for the DevportalRoot component
+ */
+export interface DevportalRootProps {
+    /**
+     * Base path for the devportal microfrontend
+     */
+    basePath?: string;
+    /**
+     * Tenant ID for scoping operations
+     */
+    tenantId?: string;
+    /**
+     * Workspace ID (optional, for workspace-scoped features)
+     */
+    workspaceId?: string;
+    /**
+     * API Gateway URL for GraphQL requests (global gateway)
+     */
+    apiGatewayUrl?: string;
+    /**
+     * Workspace gateway URL for workspace-layer operations (e.g. wspace-files-svc uploads)
+     * e.g. "https://graphqlworkspaces.burdenoff.com" or "http://localhost:4003"
+     */
+    workspacesGatewayUrl?: string;
+    /**
+     * Authentication token for API requests
+     */
+    authToken?: string;
+    /**
+     * Workspace authentication token for workspace-gateway requests (X-Workspace-Authorization).
+     * May be a cached/stale value — use getWorkspaceToken() for upload flows that need a fresh token.
+     */
+    workspaceToken?: string;
+    /**
+     * Async getter that always returns a valid (non-expired) workspace token.
+     * Call this instead of reading workspaceToken directly for workspace-layer mutations.
+     */
+    getWorkspaceToken?: () => Promise<string | null>;
+    /**
+     * Navigation function provided by the shell
+     */
+    navigate?: (path: string) => void;
+    /**
+     * Current user information
+     */
+    currentUser?: {
+        id: string;
+        email: string;
+        firstName?: string;
+        lastName?: string;
+        avatar?: string;
+    };
+    /**
+     * Optional function to register navigation items with the shell
+     */
+    registerNavItems?: (items: NavItem | NavItem[]) => () => void;
+    /**
+     * Optional function to register footer items with the shell
+     */
+    registerFooterItems?: (items: FooterItem | FooterItem[]) => () => void;
+    /**
+     * Optional callback when an application is selected
+     */
+    onApplicationSelect?: (app: Application) => void;
+    /**
+     * Optional callback when an organization is selected
+     */
+    onOrganizationSelect?: (org: DeveloperOrganization) => void;
+}
+export type AppType = "WEB_APP" | "MOBILE_APP" | "DESKTOP_APP" | "CLI_TOOL" | "API_INTEGRATION" | "WORKFLOW" | "AUTOMATION" | "WIDGET" | "BOT" | "SERVICE" | "INTEGRATION" | "ANALYST" | "ASSISTANT" | "SPECIALIST" | "NODE" | "VIBEMODULE" | "CONSOLE" | "DASHBOARD" | "PARSER" | "DATASINK";
+export type AppStatus = "DRAFT" | "SUBMITTED" | "IN_REVIEW" | "APPROVED" | "PUBLISHED" | "REJECTED" | "SUSPENDED" | "DEPRECATED" | "ACTIVE" | "INACTIVE" | "REVOKED";
+export type AppVisibility = "PUBLIC" | "PRIVATE" | "UNLISTED" | "INTERNAL";
+export type AppSubmissionReviewStatus = "PENDING" | "IN_PROGRESS" | "APPROVED" | "REJECTED" | "CHANGES_REQUESTED";
+export interface Application {
+    id: string;
+    name: string;
+    slug: string;
+    shortDescription?: string;
+    description?: string;
+    appType: AppType;
+    status: AppStatus;
+    visibility: AppVisibility;
+    tenantId: string;
+    developerId: string;
+    developerOrganizationId?: string;
+    developerOrganization?: DeveloperOrganization;
+    category?: string;
+    tags: string[];
+    keywords: string[];
+    iconUrl?: string;
+    bannerUrl?: string;
+    videoUrl?: string;
+    screenshots?: Record<string, unknown>;
+    websiteUrl?: string;
+    documentationUrl?: string;
+    supportUrl?: string;
+    privacyPolicyUrl?: string;
+    termsOfServiceUrl?: string;
+    githubUrl?: string;
+    pricingType?: string;
+    pricingDetails?: Record<string, unknown>;
+    installCount: number;
+    activeInstallCount: number;
+    averageRating?: number;
+    reviewCount: number;
+    submittedAt?: string;
+    publishedAt?: string;
+    lastReviewedAt?: string;
+    reviewStatus: AppSubmissionReviewStatus;
+    reviewNotes?: string;
+    reviewedBy?: string;
+    isFeatured: boolean;
+    isVerified: boolean;
+    requiresApproval: boolean;
+    manifest?: Record<string, unknown>;
+    config?: Record<string, unknown>;
+    metadata?: Record<string, unknown>;
+    appId?: string;
+    oauthAuthUrl?: string;
+    oauthRevokeUrl?: string;
+    createdAt: string;
+    updatedAt: string;
+    versions?: ApplicationVersion[];
+    oauthClients?: OAuthClient[];
+    apiKeys?: ApiKey[];
+    webhooks?: Webhook[];
+    scopes?: ApplicationScope[];
+}
+export interface ApplicationVersion {
+    id: string;
+    applicationId: string;
+    version: string;
+    releaseNotes?: string;
+    changelog?: string;
+    status: string;
+    isLatest: boolean;
+    isStable: boolean;
+    packageUrl?: string;
+    packageSize?: string;
+    packageHash?: string;
+    manifest?: Record<string, unknown>;
+    minPlatformVersion?: string;
+    maxPlatformVersion?: string;
+    requiredScopes: string[];
+    publishedAt?: string;
+    deprecatedAt?: string;
+    createdAt: string;
+    updatedAt: string;
+}
+export interface ApplicationScope {
+    id: string;
+    applicationId: string;
+    scope: string;
+    description?: string;
+    isRequired: boolean;
+    createdAt: string;
+}
+export type OAuthClientType = "PUBLIC" | "CONFIDENTIAL";
+export type OAuthGrantType = "AUTHORIZATION_CODE" | "REFRESH_TOKEN" | "CLIENT_CREDENTIALS" | "IMPLICIT" | "PASSWORD";
+export interface OAuthClient {
+    id: string;
+    applicationId: string;
+    name: string;
+    clientId: string;
+    clientSecret: string;
+    clientType: OAuthClientType;
+    redirectUris: string[];
+    allowedGrantTypes: OAuthGrantType[];
+    allowedScopes: string[];
+    accessTokenLifetime: number;
+    refreshTokenLifetime: number;
+    isActive: boolean;
+    requirePKCE: boolean;
+    requireConsent: boolean;
+    metadata?: Record<string, unknown>;
+    createdAt: string;
+    updatedAt: string;
+}
+export interface OAuthToken {
+    id: string;
+    clientId: string;
+    userId: string;
+    tenantId: string;
+    workspaceId?: string;
+    accessToken: string;
+    refreshToken?: string;
+    tokenType: string;
+    scopes: string[];
+    expiresAt: string;
+    refreshExpiresAt?: string;
+    isRevoked: boolean;
+    revokedAt?: string;
+    createdAt: string;
+    lastUsedAt?: string;
+}
+export type ApiKeyType = "PUBLISHABLE" | "SECRET" | "RESTRICTED";
+export interface ApiKey {
+    id: string;
+    applicationId: string;
+    name: string;
+    description?: string;
+    keyId: string;
+    keyHash?: string;
+    keyPrefix: string;
+    keyType: ApiKeyType;
+    scopes: string[];
+    permissions?: Record<string, unknown>;
+    rateLimit?: number;
+    quotaLimit?: number;
+    quotaUsed: number;
+    quotaResetAt?: string;
+    allowedIps: string[];
+    allowedDomains: string[];
+    environment?: string;
+    isActive: boolean;
+    isRevoked: boolean;
+    createdAt: string;
+    lastUsedAt?: string;
+    expiresAt?: string;
+    revokedAt?: string;
+}
+export interface ApiKeyPayload {
+    apiKey: ApiKey;
+    plainTextKey: string;
+}
+export type WebhookStatus = "ACTIVE" | "PAUSED" | "FAILED" | "DISABLED";
+export type WebhookDeliveryStatus = "PENDING" | "DELIVERING" | "DELIVERED" | "FAILED" | "RETRYING";
+export interface Webhook {
+    id: string;
+    applicationId: string;
+    name: string;
+    description?: string;
+    url: string;
+    secret?: string;
+    events: string[];
+    filters?: Record<string, unknown>;
+    retryEnabled: boolean;
+    maxRetries: number;
+    retryDelay: number;
+    status: WebhookStatus;
+    isActive: boolean;
+    successCount: number;
+    failureCount: number;
+    lastTriggeredAt?: string;
+    lastSuccessAt?: string;
+    lastFailureAt?: string;
+    lastFailureReason?: string;
+    createdAt: string;
+    updatedAt: string;
+    deliveries?: WebhookDelivery[];
+}
+export interface WebhookDelivery {
+    id: string;
+    webhookId: string;
+    eventType: string;
+    eventId: string;
+    payload: Record<string, unknown>;
+    attemptNumber: number;
+    status: WebhookDeliveryStatus;
+    requestHeaders?: Record<string, unknown>;
+    requestBody?: Record<string, unknown>;
+    responseStatus?: number;
+    responseHeaders?: Record<string, unknown>;
+    responseBody?: string;
+    deliveredAt?: string;
+    failedAt?: string;
+    nextRetryAt?: string;
+    errorMessage?: string;
+    errorCode?: string;
+    createdAt: string;
+    updatedAt: string;
+}
+export interface WebhookTestResult {
+    success: boolean;
+    statusCode?: number;
+    response?: string;
+    error?: string;
+}
+export type DeveloperOrgRole = "OWNER" | "ADMIN" | "DEVELOPER" | "VIEWER";
+export type DeveloperOrgTier = "FREE" | "DEVELOPER" | "PROFESSIONAL" | "ENTERPRISE";
+export type PartnerTier = "REGISTERED" | "SELECT" | "PREMIER";
+export type InvitationStatus = "PENDING" | "ACCEPTED" | "REJECTED" | "EXPIRED" | "CANCELLED";
+export interface DeveloperOrganization {
+    id: string;
+    name: string;
+    slug: string;
+    description?: string;
+    logoUrl?: string;
+    bannerUrl?: string;
+    websiteUrl?: string;
+    contactEmail?: string;
+    supportEmail?: string;
+    tier: DeveloperOrgTier;
+    partnerTier?: PartnerTier;
+    partnerSince?: string;
+    isVerified: boolean;
+    verifiedAt?: string;
+    verificationMethod?: string;
+    verificationRequestedAt?: string;
+    verificationStatus?: "UNVERIFIED" | "PENDING" | "VERIFIED" | "REJECTED";
+    verificationRequestNotes?: string;
+    verificationEvidenceUrl?: string;
+    verificationDomain?: string;
+    verificationRequestedBy?: string;
+    verificationReviewedAt?: string;
+    verificationReviewedBy?: string;
+    verificationReviewNotes?: string;
+    verificationRejectedReason?: string;
+    isCertified: boolean;
+    certifiedAt?: string;
+    certificationExpiry?: string;
+    totalApps: number;
+    publishedApps: number;
+    totalInstalls: number;
+    activeInstalls: number;
+    totalApiCalls: string;
+    averageRating?: number;
+    totalRevenue: number;
+    totalPlatformFees: number;
+    totalPayouts: number;
+    pendingBalance: number;
+    lifetimeRevenue: number;
+    platformFeeRate: number;
+    apiCallsLimit: number;
+    storageLimit: string;
+    apiCallsUsed: string;
+    storageUsed: string;
+    quotaResetAt?: string;
+    taxId?: string;
+    taxCountry?: string;
+    taxFormType?: string;
+    taxFormVerified: boolean;
+    legalEntityName?: string;
+    legalEntityType?: string;
+    legalAddress?: Record<string, unknown>;
+    settings?: Record<string, unknown>;
+    billingAccountId?: string;
+    billingLinkedAt?: string;
+    createdAt: string;
+    updatedAt: string;
+    members?: DeveloperOrgMember[];
+    invitations?: DeveloperOrgInvitation[];
+    applications?: Application[];
+}
+export interface DeveloperOrgMember {
+    id: string;
+    organizationId: string;
+    userId: string;
+    email?: string;
+    role: DeveloperOrgRole;
+    permissions?: Record<string, unknown>;
+    invitedBy?: string;
+    invitationId?: string;
+    isActive: boolean;
+    isSuspended: boolean;
+    suspendedAt?: string;
+    suspendedReason?: string;
+    joinedAt: string;
+    createdAt: string;
+    updatedAt: string;
+}
+export interface DeveloperOrgInvitation {
+    id: string;
+    organizationId: string;
+    invitedUserId?: string;
+    invitedEmail: string;
+    role: DeveloperOrgRole;
+    permissions?: Record<string, unknown>;
+    invitedBy: string;
+    message?: string;
+    token: string;
+    status: InvitationStatus;
+    expiresAt: string;
+    respondedAt?: string;
+    memberId?: string;
+    createdAt: string;
+    updatedAt: string;
+}
+export interface ApplicationAnalytics {
+    id: string;
+    applicationId: string;
+    date: string;
+    period: string;
+    activeUsers: number;
+    newUsers: number;
+    apiCalls: number;
+    errors: number;
+    avgResponseTime?: number;
+    sessions: number;
+    avgSessionDuration?: number;
+    createdAt: string;
+}
+export interface DeveloperOrgRevenueAnalytics {
+    id: string;
+    organizationId: string;
+    period: string;
+    periodStart: string;
+    periodEnd: string;
+    grossRevenue: number;
+    platformFees: number;
+    netRevenue: number;
+    salesCount: number;
+    refundsCount: number;
+    refundsAmount: number;
+    newSubscribers: number;
+    churnedSubscribers: number;
+    activeSubscribers: number;
+    avgRevenuePerUser: number;
+    topApps?: Array<{
+        appId: string;
+        revenue: number;
+    }>;
+    createdAt: string;
+}
+export type DevPortalPricingModel = "FREE" | "FREEMIUM" | "SUBSCRIPTION" | "ONE_TIME" | "USAGE_BASED" | "ENTERPRISE";
+export type SaleStatus = "PENDING" | "COMPLETED" | "REFUNDED" | "PARTIAL_REFUND" | "DISPUTED" | "CHARGEBACK" | "CANCELLED";
+export type PayoutStatus = "PENDING" | "PROCESSING" | "COMPLETED" | "FAILED" | "CANCELLED";
+export interface DeveloperOrgSale {
+    id: string;
+    organizationId: string;
+    applicationId: string;
+    buyerUserId: string;
+    buyerTenantId?: string;
+    installationScope: string;
+    pricingModel: DevPortalPricingModel;
+    planName?: string;
+    grossAmount: number;
+    platformFeeRate: number;
+    platformFee: number;
+    netAmount: number;
+    currency: string;
+    taxAmount?: number;
+    discountAmount?: number;
+    status: SaleStatus;
+    createdAt: string;
+}
+export interface DeveloperOrgPayout {
+    id: string;
+    organizationId: string;
+    periodStart: string;
+    periodEnd: string;
+    grossAmount: number;
+    platformFees: number;
+    netAmount: number;
+    currency: string;
+    status: PayoutStatus;
+    processedAt?: string;
+    failedAt?: string;
+    failureReason?: string;
+    createdAt: string;
+}
+export type AppInstallationStatus = "ACTIVE" | "SUSPENDED" | "TRIAL" | "EXPIRED" | "UNINSTALLED";
+export interface AppInstallation {
+    id: string;
+    applicationId: string;
+    userId: string;
+    tenantId?: string;
+    workspaceId?: string;
+    organizationId?: string;
+    scope: string;
+    installedVersion: string;
+    status: AppInstallationStatus;
+    grantedScopes: string[];
+    settings?: Record<string, unknown>;
+    installedAt: string;
+    updatedAt: string;
+}
+export type ReviewStatus = "PENDING" | "PUBLISHED" | "HIDDEN" | "FLAGGED" | "REMOVED";
+export interface AppReview {
+    id: string;
+    applicationId: string;
+    userId: string;
+    rating: number;
+    title?: string;
+    body?: string;
+    status: ReviewStatus;
+    isFeatured: boolean;
+    helpfulCount: number;
+    notHelpfulCount: number;
+    developerResponse?: string;
+    developerResponseAt?: string;
+    createdAt: string;
+    updatedAt: string;
+}
+export type DelegationStatus = "ACTIVE" | "REVOKED" | "EXPIRED";
+export interface AppUserDelegation {
+    id: string;
+    appId: string;
+    app?: {
+        id: string;
+        name: string;
+        description?: string;
+        type: string;
+        status: string;
+    };
+    userId: string;
+    scopes: string[];
+    workspaceIds: string[];
+    status: DelegationStatus;
+    grantedAt: string;
+    grantedBy: string;
+    expiresAt?: string;
+    revokedAt?: string;
+    revokedBy?: string;
+}
+export interface GrantDelegationInput {
+    appId: string;
+    userId?: string;
+    workspaceIds: string[];
+    scopes: string[];
+    expiresAt?: string;
+}
+export type AuthAppType = "ANALYST" | "API_INTEGRATION" | "ASSISTANT" | "AUTOMATION" | "BOT" | "CLI_TOOL" | "DESKTOP_APP" | "INTEGRATION" | "MOBILE_APP" | "SERVICE" | "SPECIALIST" | "WEB_APP" | "WIDGET" | "WORKFLOW";
+export type AuthAppStatus = "ACTIVE" | "INACTIVE" | "REVOKED";
+export interface AuthApp {
+    id: string;
+    name: string;
+    description?: string;
+    clientId: string;
+    type: AuthAppType;
+    status: AuthAppStatus;
+    scopes: string[];
+    redirectUris: string[];
+    ownerUserId: string;
+    tenantId: string;
+    delegations?: AppUserDelegation[];
+    createdAt: string;
+    updatedAt: string;
+}
+export interface AuthAppCreateResponse {
+    app: AuthApp;
+    clientSecret: string;
+}
+export interface CreateAuthAppInput {
+    name: string;
+    description?: string;
+    type: AuthAppType;
+    scopes: string[];
+    redirectUris?: string[];
+    tenantId?: string;
+}
+export interface UpdateAuthAppInput {
+    name?: string;
+    description?: string;
+    scopes?: string[];
+    redirectUris?: string[];
+}
+export interface AuthApiKey {
+    id: string;
+    name: string;
+    prefix: string;
+    scopes: string[];
+    appId: string;
+    appName?: string;
+    createdAt: string;
+    expiresAt?: string;
+    lastUsedAt?: string;
+}
+export interface AuthApiKeyResult {
+    apiKey: string;
+    apiSecret: string;
+    keyId: string;
+}
+export interface AuthApiKeyRotateResult {
+    apiSecret: string;
+}
+export interface GenerateAuthApiKeyInput {
+    appId: string;
+    name: string;
+    scope: string[];
+    expiresAt?: string;
+}
+export interface AuditLog {
+    id: string;
+    actorId: string;
+    actorType: string;
+    tenantId: string;
+    action: string;
+    resource: string;
+    resourceId?: string;
+    changes?: Record<string, unknown>;
+    ipAddress?: string;
+    userAgent?: string;
+    createdAt: string;
+}
+export type DevportalView = "dashboard" | "organizations" | "apps" | "oauth" | "api-keys" | "webhooks" | "delegations" | "analytics" | "revenue" | "docs" | "profile" | "settings";
+export interface ApplicationFilter {
+    search?: string;
+    status?: AppStatus;
+    visibility?: AppVisibility;
+    appType?: AppType;
+    organizationId?: string;
+    isFeatured?: boolean;
+}
+export interface WebhookFilter {
+    status?: WebhookStatus;
+    event?: string;
+}
+export declare const WEBHOOK_EVENTS: readonly ["application.created", "application.updated", "application.deleted", "application.published", "application.unpublished", "application.suspended", "installation.created", "installation.updated", "installation.deleted", "user.created", "user.updated", "user.deleted", "workspace.created", "workspace.updated", "workspace.deleted", "project.created", "project.updated", "project.deleted", "task.created", "task.updated", "task.deleted", "task.completed", "comment.created", "comment.updated", "comment.deleted", "file.uploaded", "file.deleted", "member.added", "member.removed", "member.role_changed"];
+export type WebhookEvent = (typeof WEBHOOK_EVENTS)[number];
+export declare const AVAILABLE_SCOPES: readonly [{
+    readonly scope: "user:read";
+    readonly description: "Read user profile information";
+    readonly category: "User";
+}, {
+    readonly scope: "user:write";
+    readonly description: "Modify user profile information";
+    readonly category: "User";
+}, {
+    readonly scope: "user:email";
+    readonly description: "Access user email address";
+    readonly category: "User";
+}, {
+    readonly scope: "workspace:read";
+    readonly description: "Read workspace information";
+    readonly category: "Workspace";
+}, {
+    readonly scope: "workspace:write";
+    readonly description: "Create and modify workspaces";
+    readonly category: "Workspace";
+}, {
+    readonly scope: "workspace:delete";
+    readonly description: "Delete workspaces";
+    readonly category: "Workspace";
+}, {
+    readonly scope: "workspace:members";
+    readonly description: "Manage workspace members";
+    readonly category: "Workspace";
+}, {
+    readonly scope: "project:read";
+    readonly description: "Read project information";
+    readonly category: "Project";
+}, {
+    readonly scope: "project:write";
+    readonly description: "Create and modify projects";
+    readonly category: "Project";
+}, {
+    readonly scope: "project:delete";
+    readonly description: "Delete projects";
+    readonly category: "Project";
+}, {
+    readonly scope: "task:read";
+    readonly description: "Read tasks";
+    readonly category: "Task";
+}, {
+    readonly scope: "task:write";
+    readonly description: "Create and modify tasks";
+    readonly category: "Task";
+}, {
+    readonly scope: "task:delete";
+    readonly description: "Delete tasks";
+    readonly category: "Task";
+}, {
+    readonly scope: "file:read";
+    readonly description: "Read files";
+    readonly category: "File";
+}, {
+    readonly scope: "file:write";
+    readonly description: "Upload and modify files";
+    readonly category: "File";
+}, {
+    readonly scope: "file:delete";
+    readonly description: "Delete files";
+    readonly category: "File";
+}, {
+    readonly scope: "comment:read";
+    readonly description: "Read comments";
+    readonly category: "Comment";
+}, {
+    readonly scope: "comment:write";
+    readonly description: "Create and modify comments";
+    readonly category: "Comment";
+}, {
+    readonly scope: "comment:delete";
+    readonly description: "Delete comments";
+    readonly category: "Comment";
+}, {
+    readonly scope: "offline_access";
+    readonly description: "Access data while user is offline";
+    readonly category: "Access";
+}];
+export type AvailableScope = (typeof AVAILABLE_SCOPES)[number]["scope"];
+//# sourceMappingURL=index.d.ts.map