@topolo/sdk 0.4.7 → 0.4.8

package/dist/index.d.cts

@@ -88,6 +88,11 @@ interface RequestOptions {
     method?: 'GET' | 'POST' | 'PUT' | 'PATCH' | 'DELETE';
     query?: Record<string, string | number | boolean | undefined>;
     body?: unknown;
+    /** Workspace-boundary resource context for resource-scoped API keys. */
+    resource?: {
+        resourceType: string;
+        resourceId: string;
+    };
     /** Explicit write-acknowledgement for mutating calls. */
     confirm?: boolean;
     /** Extra headers appended after auth/audit headers. */
@@ -110,6 +115,17 @@ interface TopoloServiceCatalogEntry {
     surfaceKind: string | null;
     launchable: boolean;
     permissions: string[];
+    apiKeyResource: TopoloApiKeyResourceMetadata | null;
+    apiKeyResources: TopoloApiKeyResourceMetadata[];
+}
+interface TopoloApiKeyResourceMetadata {
+    resourceType: string;
+    label: string;
+    emptyLabel: string;
+    resourceConcept: 'workspace';
+    canonicalResourceType: 'workspace';
+    defaultEntitlement: 'enterprise';
+    exceptionPolicy: 'app_or_organization';
 }
 interface TopoloActionCatalogEntry {
     actionId: string;
@@ -234,32 +250,32 @@ interface CredentialIntrospection {
 }
 
 declare const SERVICES: {
-    readonly agent: "https://agent-api.topolo.app";
+    readonly agent: "https://agent.topolo.app";
     readonly auth: "https://auth.topolo.app";
     readonly backup: "https://backup.topolo.app";
     readonly books: "https://books.topolo.app";
     readonly bugfix: "https://bugfix.topolo.app";
-    readonly bytes: "https://bytes-api.topolo.app";
+    readonly bytes: "https://bytes.topolo.app";
     readonly calendar: "https://calendar.topolo.app";
     readonly capacity: "https://capacity.topolo.app";
     readonly chat: "https://chat.topolo.app";
-    readonly commerce: "https://commerce-api.topolo.app";
+    readonly commerce: "https://commerce.topolo.app";
     readonly compose: "https://compose.topolo.app";
     readonly consent: "https://consent.topolo.app";
-    readonly crm: "https://crm-api.topolo.app";
+    readonly crm: "https://crm.topolo.app";
     readonly developers: "https://developers.topolo.app";
     readonly director: "https://director.topolo.app";
-    readonly feed: "https://feed-api.topolo.app";
+    readonly feed: "https://feed.topolo.app";
     readonly flow: "https://flow.topolo.app";
-    readonly forecast: "https://forecast-api.topolo.app";
+    readonly forecast: "https://forecast.topolo.app";
     readonly forms: "https://forms.topolo.app";
     readonly home: "https://home.topolo.app";
     readonly insights: "https://insights.topolo.app";
     readonly inventory: "https://inventory.topolo.app";
-    readonly learn: "https://learn-api.topolo.app";
+    readonly learn: "https://learn.topolo.app";
     readonly localize: "https://localize.topolo.app";
-    readonly mail: "https://mail-api.topolo.app";
-    readonly mdm: "https://mdm-api.topolo.app";
+    readonly mail: "https://mail.topolo.app";
+    readonly mdm: "https://mdm.topolo.app";
     readonly messages: "https://messages.topolo.app";
     readonly nexus: "https://nexus-api.topolo.app";
     readonly notify: "https://notify.topolo.app";
@@ -268,20 +284,19 @@ declare const SERVICES: {
     readonly p2p: "https://p2p.topolo.app";
     readonly pay: "https://pay.topolo.app";
     readonly people: "https://people.topolo.app";
-    readonly pulse: "https://pulse.topolo.app";
     readonly "quro.api": "https://api.ol0.me";
     readonly "quro.redirect": "https://ol0.me";
-    readonly roadmapper: "https://roadmapper-api.topolo.app";
+    readonly roadmapper: "https://roadmapper.topolo.app";
     readonly sign: "https://sign.topolo.app";
-    readonly social_studio: "https://studio-api.topolo.app";
-    readonly socialize: "https://socialize-api.topolo.app";
+    readonly social_studio: "https://studio.topolo.app";
+    readonly socialize: "https://socialize.topolo.app";
     readonly spaces: "https://spaces.topolo.app";
     readonly status: "https://status.topolo.app";
     readonly success: "https://success.topolo.app";
     readonly support: "https://support.topolo.app";
     readonly survey: "https://survey.topolo.app";
     readonly voice: "https://voice.topolo.app";
-    readonly web: "https://web-api.topolo.app";
+    readonly web: "https://web.topolo.app";
 };
 type ServiceId = keyof typeof SERVICES;
 
@@ -322,14 +337,14 @@ declare const APPLICATIONS: {
             readonly apiUrl: "https://agent.topolo.app";
             readonly domains: readonly ["agent.topolo.app"];
             readonly routes: readonly [];
-            readonly serviceId: null;
+            readonly serviceId: "agent";
         }, {
             readonly name: "topolo-agent-api";
             readonly kind: "worker";
-            readonly apiUrl: "https://agent-api.topolo.app";
-            readonly domains: readonly ["agent-api.topolo.app"];
+            readonly apiUrl: null;
+            readonly domains: readonly [];
             readonly routes: readonly [];
-            readonly serviceId: "agent";
+            readonly serviceId: null;
         }];
     };
     readonly auth: {
@@ -416,14 +431,14 @@ declare const APPLICATIONS: {
             readonly apiUrl: "https://bytes.topolo.app";
             readonly domains: readonly ["bytes.topolo.app"];
             readonly routes: readonly [];
-            readonly serviceId: null;
+            readonly serviceId: "bytes";
         }, {
             readonly name: "topolo-bytes-api";
             readonly kind: "worker";
-            readonly apiUrl: "https://bytes-api.topolo.app";
-            readonly domains: readonly ["bytes-api.topolo.app"];
+            readonly apiUrl: null;
+            readonly domains: readonly [];
             readonly routes: readonly [];
-            readonly serviceId: "bytes";
+            readonly serviceId: null;
         }];
     };
     readonly calendar: {
@@ -498,10 +513,10 @@ declare const APPLICATIONS: {
         readonly deployTargets: readonly [{
             readonly name: "topolo-commerce-api";
             readonly kind: "worker";
-            readonly apiUrl: "https://commerce-api.topolo.app";
-            readonly domains: readonly ["commerce-api.topolo.app"];
+            readonly apiUrl: null;
+            readonly domains: readonly [];
             readonly routes: readonly [];
-            readonly serviceId: "commerce";
+            readonly serviceId: null;
         }, {
             readonly name: "topolo-commerce-guest-web";
             readonly kind: "worker";
@@ -515,7 +530,7 @@ declare const APPLICATIONS: {
             readonly apiUrl: "https://commerce.topolo.app";
             readonly domains: readonly ["commerce.topolo.app"];
             readonly routes: readonly [];
-            readonly serviceId: null;
+            readonly serviceId: "commerce";
         }, {
             readonly name: "topolo-commerce-station-web";
             readonly kind: "worker";
@@ -581,17 +596,17 @@ declare const APPLICATIONS: {
         readonly deployTargets: readonly [{
             readonly name: "topolo-crm-api";
             readonly kind: "worker";
-            readonly apiUrl: "https://crm-api.topolo.app";
-            readonly domains: readonly ["crm-api.topolo.app"];
+            readonly apiUrl: null;
+            readonly domains: readonly [];
             readonly routes: readonly [];
-            readonly serviceId: "crm";
+            readonly serviceId: null;
         }, {
             readonly name: "topolo-crm-app";
             readonly kind: "worker";
             readonly apiUrl: "https://crm.topolo.app";
             readonly domains: readonly ["crm.topolo.app"];
             readonly routes: readonly [];
-            readonly serviceId: null;
+            readonly serviceId: "crm";
         }];
     };
     readonly developers: {
@@ -687,17 +702,17 @@ declare const APPLICATIONS: {
         }, {
             readonly name: "topolo-feed-api";
             readonly kind: "worker";
-            readonly apiUrl: "https://feed-api.topolo.app";
-            readonly domains: readonly ["feed-api.topolo.app"];
+            readonly apiUrl: null;
+            readonly domains: readonly [];
             readonly routes: readonly [];
-            readonly serviceId: "feed";
+            readonly serviceId: null;
         }, {
             readonly name: "topolo-feed-web";
             readonly kind: "worker";
             readonly apiUrl: "https://feed.topolo.app";
             readonly domains: readonly ["feed.topolo.app"];
             readonly routes: readonly [];
-            readonly serviceId: null;
+            readonly serviceId: "feed";
         }];
     };
     readonly flow: {
@@ -736,14 +751,14 @@ declare const APPLICATIONS: {
             readonly apiUrl: "https://forecast.topolo.app";
             readonly domains: readonly ["forecast.topolo.app"];
             readonly routes: readonly [];
-            readonly serviceId: null;
+            readonly serviceId: "forecast";
         }, {
             readonly name: "topolo-forecast-api";
             readonly kind: "worker";
-            readonly apiUrl: "https://forecast-api.topolo.app";
-            readonly domains: readonly ["forecast-api.topolo.app"];
+            readonly apiUrl: null;
+            readonly domains: readonly [];
             readonly routes: readonly [];
-            readonly serviceId: "forecast";
+            readonly serviceId: null;
         }];
     };
     readonly forms: {
@@ -851,14 +866,14 @@ declare const APPLICATIONS: {
             readonly apiUrl: "https://learn.topolo.app";
             readonly domains: readonly ["learn.topolo.app"];
             readonly routes: readonly [];
-            readonly serviceId: null;
+            readonly serviceId: "learn";
         }, {
             readonly name: "topolo-learn-api";
             readonly kind: "worker";
-            readonly apiUrl: "https://learn-api.topolo.app";
-            readonly domains: readonly ["learn-api.topolo.app"];
+            readonly apiUrl: null;
+            readonly domains: readonly [];
             readonly routes: readonly [];
-            readonly serviceId: "learn";
+            readonly serviceId: null;
         }];
     };
     readonly localize: {
@@ -890,14 +905,14 @@ declare const APPLICATIONS: {
             readonly apiUrl: "https://mail.topolo.app";
             readonly domains: readonly ["mail.topolo.app"];
             readonly routes: readonly [];
-            readonly serviceId: null;
+            readonly serviceId: "mail";
         }, {
             readonly name: "topolo-mail-api";
             readonly kind: "worker";
-            readonly apiUrl: "https://mail-api.topolo.app";
-            readonly domains: readonly ["mail-api.topolo.app"];
+            readonly apiUrl: null;
+            readonly domains: readonly [];
             readonly routes: readonly [];
-            readonly serviceId: "mail";
+            readonly serviceId: null;
         }];
     };
     readonly mdm: {
@@ -910,17 +925,17 @@ declare const APPLICATIONS: {
         readonly deployTargets: readonly [{
             readonly name: "topolo-mdm-api";
             readonly kind: "worker";
-            readonly apiUrl: "https://mdm-api.topolo.app";
-            readonly domains: readonly ["mdm-api.topolo.app"];
+            readonly apiUrl: null;
+            readonly domains: readonly [];
             readonly routes: readonly [];
-            readonly serviceId: "mdm";
+            readonly serviceId: null;
         }, {
             readonly name: "topolo-mdm-console";
             readonly kind: "worker";
             readonly apiUrl: "https://mdm.topolo.app";
             readonly domains: readonly ["mdm.topolo.app"];
             readonly routes: readonly [];
-            readonly serviceId: null;
+            readonly serviceId: "mdm";
         }];
     };
     readonly messages: {
@@ -1107,29 +1122,6 @@ declare const APPLICATIONS: {
             readonly serviceId: null;
         }];
     };
-    readonly pulse: {
-        readonly id: "pulse";
-        readonly appDir: "TopoloPulse";
-        readonly name: "topolo-pulse";
-        readonly packageName: "topolo-pulse";
-        readonly productionUrl: "https://pulse.topolo.app";
-        readonly services: readonly ["pulse"];
-        readonly deployTargets: readonly [{
-            readonly name: "topolo-pulse";
-            readonly kind: "worker";
-            readonly apiUrl: "https://pulse.topolo.app";
-            readonly domains: readonly ["pulse.topolo.app"];
-            readonly routes: readonly [];
-            readonly serviceId: "pulse";
-        }, {
-            readonly name: "topolo-pulse-api";
-            readonly kind: "worker";
-            readonly apiUrl: null;
-            readonly domains: readonly [];
-            readonly routes: readonly [];
-            readonly serviceId: null;
-        }];
-    };
     readonly quro: {
         readonly id: "quro";
         readonly appDir: "TopoloQuro";
@@ -1173,14 +1165,14 @@ declare const APPLICATIONS: {
             readonly apiUrl: "https://roadmapper.topolo.app";
             readonly domains: readonly ["roadmapper.topolo.app"];
             readonly routes: readonly [];
-            readonly serviceId: null;
+            readonly serviceId: "roadmapper";
         }, {
             readonly name: "topolo-roadmapper-api";
             readonly kind: "worker";
-            readonly apiUrl: "https://roadmapper-api.topolo.app";
-            readonly domains: readonly ["roadmapper-api.topolo.app"];
+            readonly apiUrl: null;
+            readonly domains: readonly [];
             readonly routes: readonly [];
-            readonly serviceId: "roadmapper";
+            readonly serviceId: null;
         }];
     };
     readonly sign: {
@@ -1219,14 +1211,14 @@ declare const APPLICATIONS: {
             readonly apiUrl: "https://studio.topolo.app";
             readonly domains: readonly ["studio.topolo.app"];
             readonly routes: readonly [];
-            readonly serviceId: null;
+            readonly serviceId: "social_studio";
         }, {
             readonly name: "topolo-social-studio-api";
             readonly kind: "worker";
-            readonly apiUrl: "https://studio-api.topolo.app";
-            readonly domains: readonly ["studio-api.topolo.app"];
+            readonly apiUrl: null;
+            readonly domains: readonly [];
             readonly routes: readonly [];
-            readonly serviceId: "social_studio";
+            readonly serviceId: null;
         }, {
             readonly name: "topolo-social-studio-queue";
             readonly kind: "worker";
@@ -1249,14 +1241,14 @@ declare const APPLICATIONS: {
             readonly apiUrl: "https://socialize.topolo.app";
             readonly domains: readonly ["socialize.topolo.app"];
             readonly routes: readonly [];
-            readonly serviceId: null;
+            readonly serviceId: "socialize";
         }, {
             readonly name: "topolo-socialize-api";
             readonly kind: "worker";
-            readonly apiUrl: "https://socialize-api.topolo.app";
-            readonly domains: readonly ["socialize-api.topolo.app"];
+            readonly apiUrl: null;
+            readonly domains: readonly [];
             readonly routes: readonly [];
-            readonly serviceId: "socialize";
+            readonly serviceId: null;
         }, {
             readonly name: "topolo-socialize-scheduler";
             readonly kind: "worker";
@@ -1407,10 +1399,10 @@ declare const APPLICATIONS: {
         readonly deployTargets: readonly [{
             readonly name: "topolo-web-api";
             readonly kind: "worker";
-            readonly apiUrl: "https://web-api.topolo.app";
-            readonly domains: readonly ["web-api.topolo.app"];
+            readonly apiUrl: null;
+            readonly domains: readonly [];
             readonly routes: readonly [];
-            readonly serviceId: "web";
+            readonly serviceId: null;
         }, {
             readonly name: "topolo-web-runtime";
             readonly kind: "worker";
@@ -1424,7 +1416,7 @@ declare const APPLICATIONS: {
             readonly apiUrl: "https://web.topolo.app";
             readonly domains: readonly ["web.topolo.app"];
             readonly routes: readonly [];
-            readonly serviceId: null;
+            readonly serviceId: "web";
         }];
     };
 };
@@ -1506,8 +1498,8 @@ declare const APPLICATION_REQUIREMENTS: readonly [{
     readonly title: "Use the shared shell, launcher, and account menu";
     readonly summary: "Browser applications should feel like one platform and should not create isolated navigation or account surfaces.";
     readonly appliesTo: readonly ["browser"];
-    readonly evidence: readonly ["@topolo/ui-kit is used for the platform shell where the app has authenticated UI", "The shared launcher/app switcher is reachable from authenticated app chrome", "Account menu and sign-out behavior use TopoloAppShell or TopoloAccountMenu", "Authenticated app body content stays inside the viewport on mobile and desktop widths"];
-    readonly implementation: readonly ["Use TopoloAppShell for authenticated app layouts", "Use TopoloAccountMenu when a partial-shell surface still needs account chrome", "Pass app-specific account actions as additive menu items instead of forking dropdowns", "Use shared design tokens and platform UI primitives before creating local equivalents", "Keep mobile and desktop shell behavior aligned with the platform UI kit", "Constrain app-owned workspace wrappers with min-width: 0, width: auto, and viewport-aware max-width so shell padding cannot create page-level horizontal overflow"];
+    readonly evidence: readonly ["@topolo-io/app-shell is used for the platform shell where the app has authenticated UI", "@topolo-io/app-launcher keeps the shared launcher/app switcher reachable from authenticated app chrome", "Account menu and sign-out behavior use TopoloAppShell or the ui-kit TopoloAccountMenu primitive", "Repeated app body surfaces use shared TopoloAppLayout primitives instead of local stat cards, empty states, or status badges", "Local preview supports deterministic visual QA fixtures for overview, list, detail, settings, and empty/loading states", "Authenticated app body content stays inside the viewport on mobile and desktop widths"];
+    readonly implementation: readonly ["Use @topolo-io/app-shell TopoloAppShell for authenticated app layouts", "Use the @topolo-io/ui-kit TopoloAccountMenu primitive when a partial-shell surface still needs account chrome", "Pass app-specific account actions as additive menu items instead of forking dropdowns", "Use shared design tokens and platform UI primitives before creating local equivalents", "Use TopoloAppMetricCard, TopoloAppEmptyState, TopoloAppStatusBadge, TopoloAppGrid, and TopoloAppSection for repeated app body patterns", "Keep visual QA fixtures available through visualQa=1 or __devpreview=1 so screenshot checks do not depend on live API state", "Keep mobile and desktop shell behavior aligned with the platform UI kit", "Constrain app-owned workspace wrappers with min-width: 0, width: auto, and viewport-aware max-width so shell padding cannot create page-level horizontal overflow"];
 }, {
     readonly id: "service-registration-and-scopes";
     readonly title: "Register protected APIs as platform services";
@@ -2099,4 +2091,4 @@ declare function createTopolo(options: TopoloClientOptions): {
 };
 type Topolo = ReturnType<typeof createTopolo>;
 
-export { APPLICATIONS, APPLICATION_REQUIREMENTS, APPLICATION_REQUIREMENTS_VERSION, type AgentIdentity, type ApplicationCatalogEntry, type ApplicationDeployTarget, type ApplicationId, type ApplicationRequirement, type ApplicationRequirementAudit, type ApplicationRequirementFinding, type ApplicationRequirementMigrationItem, type ApplicationRequirementScope, type ApplicationRequirementScore, type ApplicationRequirementStatus, type ApplicationRequirementsAuditReport, type CredentialIntrospection, type CrmContactSummary, CrmModule, DEFAULT_SERVICE_URLS, type DeviceAuthorizationResponse, IdentityModule, type ListContactsOptions, type ListContactsResult, type OAuthHelperOptions, type P2PActionDetail, type P2PActionRequestInput, type P2PActionRequestResult, type P2PActionRow, type P2PActionRun, type P2PCapability, type P2PConnection, type P2PHold, type P2PLedgerEntry, P2PModule, type P2PPolicy, type P2PPricingModel, type P2PSettlementBatch, type P2PSettlementGroup, type PublishCapabilityInput, type RequestOptions, type ServiceCatalogUrlEntry, type ServiceId, TOPOLO_WIDGET_ENDPOINT, TOPOLO_WIDGET_REFRESH_INTERVAL_MS, type TokenResponse, type Topolo, type TopoloActionCatalogEntry, TopoloAuthError, type TopoloChartWidget, TopoloClient, type TopoloClientOptions, type TopoloCredential, type TopoloDebugEvent, TopoloHttpError, type TopoloNotificationsWidget, TopoloOAuth, TopoloPermissionError, type TopoloQuickActionsWidget, type TopoloRecentActivityWidget, TopoloSdkError, type TopoloServiceCatalogEntry, type TopoloStatsWidget, type TopoloWidget, type TopoloWidgetActionItem, type TopoloWidgetActivityItem, type TopoloWidgetApiResponse, type TopoloWidgetBase, type TopoloWidgetConfig, type TopoloWidgetDraft, type TopoloWidgetMetric, type TopoloWidgetNotificationItem, type TopoloWidgetResponseOptions, type TopoloWidgetSnapshotMetadata, type TopoloWidgetSnapshotMetric, type TopoloWidgetType, type TopoloWidgetValidationResult, applicationRequirementScopes, auditAllApplicationRequirements, auditApplicationRequirements, createTopolo, createTopoloWidgetError, createTopoloWidgetResponse, defineTopoloChartWidget, defineTopoloNotificationsWidget, defineTopoloQuickActionsWidget, defineTopoloRecentActivityWidget, defineTopoloStatsWidget, requirementsForApplication, resolveCatalogServiceUrl, resolveServiceUrl, validateTopoloWidgetResponse };
+export { APPLICATIONS, APPLICATION_REQUIREMENTS, APPLICATION_REQUIREMENTS_VERSION, type AgentIdentity, type ApplicationCatalogEntry, type ApplicationDeployTarget, type ApplicationId, type ApplicationRequirement, type ApplicationRequirementAudit, type ApplicationRequirementFinding, type ApplicationRequirementMigrationItem, type ApplicationRequirementScope, type ApplicationRequirementScore, type ApplicationRequirementStatus, type ApplicationRequirementsAuditReport, type CredentialIntrospection, type CrmContactSummary, CrmModule, DEFAULT_SERVICE_URLS, type DeviceAuthorizationResponse, IdentityModule, type ListContactsOptions, type ListContactsResult, type OAuthHelperOptions, type P2PActionDetail, type P2PActionRequestInput, type P2PActionRequestResult, type P2PActionRow, type P2PActionRun, type P2PCapability, type P2PConnection, type P2PHold, type P2PLedgerEntry, P2PModule, type P2PPolicy, type P2PPricingModel, type P2PSettlementBatch, type P2PSettlementGroup, type PublishCapabilityInput, type RequestOptions, type ServiceCatalogUrlEntry, type ServiceId, TOPOLO_WIDGET_ENDPOINT, TOPOLO_WIDGET_REFRESH_INTERVAL_MS, type TokenResponse, type Topolo, type TopoloActionCatalogEntry, type TopoloApiKeyResourceMetadata, TopoloAuthError, type TopoloChartWidget, TopoloClient, type TopoloClientOptions, type TopoloCredential, type TopoloDebugEvent, TopoloHttpError, type TopoloNotificationsWidget, TopoloOAuth, TopoloPermissionError, type TopoloQuickActionsWidget, type TopoloRecentActivityWidget, TopoloSdkError, type TopoloServiceCatalogEntry, type TopoloStatsWidget, type TopoloWidget, type TopoloWidgetActionItem, type TopoloWidgetActivityItem, type TopoloWidgetApiResponse, type TopoloWidgetBase, type TopoloWidgetConfig, type TopoloWidgetDraft, type TopoloWidgetMetric, type TopoloWidgetNotificationItem, type TopoloWidgetResponseOptions, type TopoloWidgetSnapshotMetadata, type TopoloWidgetSnapshotMetric, type TopoloWidgetType, type TopoloWidgetValidationResult, applicationRequirementScopes, auditAllApplicationRequirements, auditApplicationRequirements, createTopolo, createTopoloWidgetError, createTopoloWidgetResponse, defineTopoloChartWidget, defineTopoloNotificationsWidget, defineTopoloQuickActionsWidget, defineTopoloRecentActivityWidget, defineTopoloStatsWidget, requirementsForApplication, resolveCatalogServiceUrl, resolveServiceUrl, validateTopoloWidgetResponse };