@madewithremy/admin 0.1.3 → 0.1.5

package/dist/index.d.ts

@@ -558,6 +558,121 @@ declare namespace analytics {
   export { type analytics_AiSourcesParams as AiSourcesParams, type analytics_CrawlersParams as CrawlersParams, type analytics_MapParams as MapParams, type analytics_SourcesParams as SourcesParams, analytics_aiSources as aiSources, analytics_batch as batch, analytics_crawlers as crawlers, analytics_live as live, analytics_map as map, query$1 as query, analytics_sources as sources };
 }
 
+/**
+ * Response types for the v2 app-events observability endpoints.
+ *
+ * Transcribed from youai-api:
+ *   src/http/routes/V2Apps/manage/appEvents.ts          — routes
+ *   src/http/routes/V2Apps/serve/events/registry.ts     — ChannelActivityRow
+ *   src/http/routes/V2Apps/serve/events/publish.ts      — delivered semantics
+ */
+/** One channel's recent activity, from the channels view. */
+interface EventChannelActivity {
+    channel: string;
+    /** Last publish naming this channel (ms since epoch), if any in 24h. */
+    lastPublishAt?: number;
+    /** Last subscription naming this channel (ms since epoch), if any in 24h. */
+    lastSubscribeAt?: number;
+    /** Live subscriber connections right now. */
+    subscribers: number;
+}
+/** GET /_internal/v2/apps/:appId/events/channels */
+interface EventsChannelsListResult {
+    /** The environment scope inspected: `live` | `preview:<id>` | `dev:<id>`. */
+    scope: string;
+    /** Recency-sorted, capped at 200 rows, 24h window. */
+    channels: EventChannelActivity[];
+}
+/** POST /_internal/v2/apps/:appId/events/publish */
+interface EventsPublishResult {
+    /**
+     * Live subscriber connections counted across the published channels.
+     * `0` means nobody is listening right now — normal for a nudge, not an
+     * error.
+     */
+    delivered: number;
+    /**
+     * The platform-stamped publish id — the same id arrives on every delivered
+     * frame, so it correlates a test publish with `events tail` output.
+     */
+    id: string;
+    scope: string;
+}
+/**
+ * One frame printed by `events tail` (also the subscribe stream's shape).
+ * A slow reader may also see `{ type: 'events_dropped', count, ts }` — the
+ * platform drops rather than buffers when a consumer falls behind, and says
+ * how many frames it dropped once the stream drains.
+ */
+interface EventsTailFrame {
+    /** Platform-stamped publish id (consumer dedupe key: `id` + `channel`). */
+    id: string;
+    channel: string;
+    data: unknown;
+    /** Publish time, ms since epoch. */
+    ts: number;
+}
+
+/**
+ * App-events observability operations.
+ *
+ * Ops are pure: (ctx, params) → typed result, throwing AdminApiError /
+ * AdminTimeoutError. The live tail is CLI-only (src/cliStream.ts) — the
+ * import layer stays non-streaming by design.
+ */
+
+interface EventsScopeParams {
+    /**
+     * Environment scope to inspect: `live` (default), `preview:<releaseId>`,
+     * or `dev:<sessionId>` — publishes and subscriptions never cross scopes,
+     * so a tunnel session's events are visible only under its `dev:` scope.
+     */
+    scope?: string;
+}
+interface EventsPublishParams extends EventsScopeParams {
+    /** Exact channel name(s) — no wildcards anywhere in app events. */
+    channels: string | string[];
+    /** The payload subscribers receive (≤32k serialized characters). */
+    data: unknown;
+}
+/**
+ * Channels with a publish or a subscription in the last 24h, with live
+ * subscriber counts — recency-sorted, capped at 200.
+ *
+ * The debugging read: a channel with subscribers but no publishes (or the
+ * reverse) usually means the frontend and backend spell the channel
+ * differently.
+ *
+ * @example
+ * const { channels } = await admin.events.channelsList();
+ * const mismatch = channels.filter((c) => c.subscribers > 0 && !c.lastPublishAt);
+ */
+declare function channelsList(ctx: AdminContext, params?: EventsScopeParams): Promise<EventsChannelsListResult>;
+/**
+ * Publish a test event, exactly as the app's own `events.publish` would —
+ * same validation, same delivery, same metering. Lets a frontend subscriber
+ * be verified before the backend trigger exists.
+ *
+ * `delivered` counts live subscriber connections per published channel;
+ * `0` is normal (nobody listening), never an error.
+ *
+ * @throws AdminApiError `invalid_channels` / `payload_too_large` (400).
+ * @example
+ * const { delivered } = await admin.events.publish({
+ *   channels: 'jobs:usr_123',
+ *   data: { type: 'ping' },
+ * });
+ */
+declare function publish(ctx: AdminContext, params: EventsPublishParams): Promise<EventsPublishResult>;
+
+type appEvents_EventsPublishParams = EventsPublishParams;
+type appEvents_EventsScopeParams = EventsScopeParams;
+declare const appEvents_channelsList: typeof channelsList;
+declare const appEvents_publish: typeof publish;
+declare namespace appEvents {
+  export { type appEvents_EventsPublishParams as EventsPublishParams, type appEvents_EventsScopeParams as EventsScopeParams, appEvents_channelsList as channelsList, appEvents_publish as publish };
+}
+
 /**
  * Response types for src/commands/crashes.ts.
  * Transcribed from:
@@ -5211,6 +5326,7 @@ declare function buildClient(ctx: AdminContext): {
     forApp(appId: string): /*elided*/ any;
     agent: BoundOps<typeof agent>;
     analytics: BoundOps<typeof analytics>;
+    events: BoundOps<typeof appEvents>;
     crashes: BoundOps<typeof crashes>;
     cron: BoundOps<typeof cron>;
     data: BoundOps<typeof data>;
@@ -5290,4 +5406,4 @@ declare class AdminTimeoutError extends Error {
 
 declare const admin: AdminClient;
 
-export { AdminApiError, type AdminClient, type AdminClientOptions, type AdminContext, AdminTimeoutError, type AgentThreadDetail, type AgentThreadListItem, type AgentThreadsGetResult, type AgentThreadsListResult, type AgentToolCall, type AgentTranscriptMessage, type AgentTurnError, type AnalyticsAiHostRow, type AnalyticsAiSourcesResult, type AnalyticsAiVendorRow, type AnalyticsBatchResult, type AnalyticsCrawlersOverviewResult, type AnalyticsCrawlersRecentResult, type AnalyticsCrawlersRecentRow, type AnalyticsCrawlersResult, type AnalyticsCrawlersTimeseriesBucket, type AnalyticsCrawlersTimeseriesResult, type AnalyticsLiveResult, type AnalyticsMapPoint, type AnalyticsMapResult, type AnalyticsMetric, type AnalyticsQueryResult, type AnalyticsQueryResultRow, type AnalyticsSourceRow, type AnalyticsSourcesResult, type AppCronJobStatus, type AppCronJobStatusReason, type AppCronRunState, type AppEmailSuppression, type AppSecretRow, type CrashGroup, type CrashOccurrenceRow, type CrashesGetResult, type CrashesListResult, type CrashesOccurrencesResult, type CrashesStatsBucket, type CrashesStatsResult, type CronJobDecorated, type CronOverviewResult, type CronRunResult, type CronRunSummary, type DashboardLiveRelease, type DashboardReleaseMethod, type DashboardResult, type DataLiftFromDevResult, type DataLiftFromLiveResult, type DataSourcesBuildProgress, type DataSourcesChunkingConfig, type DataSourcesConfigResult, type DataSourcesConfigUpdateResult, type DataSourcesDeleteResult, type DataSourcesDocument, type DataSourcesDocumentConfirmResult, type DataSourcesDocumentDeleteResult, type DataSourcesDocumentStatus, type DataSourcesDocumentsResult, type DataSourcesDropResult, type DataSourcesIngestConfig, type DataSourcesIngestUpdate, type DataSourcesListEntry, type DataSourcesListResult, type DataSourcesPromoteResult, type DataSourcesRetrievalConfig, type DataSourcesRetrievalUpdate, type DataSourcesRevectorizeResult, type DataSourcesSearchCitation, type DataSourcesSearchResult, type DataSourcesSearchResultItem, type DataSourcesUploadTokenResult, type DatasetFile, type DbQueryResult, type DiagnosticsAuditEnvironment, type DiagnosticsDashboardResult, type DiagnosticsFinding, type DiagnosticsLighthouseScores, type DiagnosticsPayload, type DiagnosticsReleaseResult, type DiagnosticsRuntimeFindings, type DomainsCheckResult, type DomainsCustomAddResult, type DomainsCustomCheckResult, type DomainsCustomHostnameUiStatus, type DomainsCustomHostnameView, type DomainsCustomListResult, type DomainsCustomRemoveResult, type DomainsCustomRetryResult, type DomainsDnsInstructions, type DomainsGetResult, type DomainsSetResult, type EmailBatchLifecycle, type EmailBatchResult, type EmailBatchSummary, type EmailBatchesResult, type EmailDomainBase, type EmailEffectiveSender, type EmailInboxResult, type EmailListResult, type EmailMessageKind, type EmailMessageResult, type EmailMessageStatus, type EmailSenderTier, type EmailSendingStatusResult, type EmailStatsResult, type EmailSummary, type EmailSuppressResult, type EmailSuppressionsResult, type EmailUnsuppressResult, type FilesDeleteResult, type FilesFileMeta, type FilesListEntry, type FilesListResult, type FilesLsResult, type FilesScanBadge, type FilesScanFlagged, type FilesScanStore, type FilesStatResult, type FilesStoreSummaryEntry, type FilesUploadUrlResult, type FilesUrlResult, type FrontendErrorType, type InboundDnsInstructions, type InboundEmailDomainAddResult, type InboundEmailDomainCheckResult, type InboundEmailDomainDeleteResult, type InboundEmailDomainUiStatus, type InboundEmailDomainVerifyResult, type InboundEmailDomainView, type InboundEmailDomainsListResult, type InboxEmailPreview, type IssueAuthorKind, type IssueCommentRow, type IssueEventType, type IssueKind, type IssueRow, type IssueStatus, type IssuesCommentResult, type IssuesCreateResult, type IssuesDeleteResult, type IssuesGetResult, type IssuesListResult, type IssuesUpdateResult, type JewelPairRow, type JewelPairSummaryRow, type JewelVerdict, type JewelsDatasetSummary, type JewelsDryrunResult, type JewelsExportResult, type JewelsGradeResult, type JewelsGrading, type JewelsOverviewResult, type JewelsPairResult, type JewelsPairsResult, type JewelsQueueResult, type JewelsResolveResult, type JewelsRunResult, type JewelsRunsResult, type JewelsTimeseriesBucket, type JewelsTimeseriesResult, type JewelsTrainResult, type LiftedDatabase, type MethodsInvokeResult, type OutboundDnsInstructions, type OutboundEmailDomainAddResult, type OutboundEmailDomainCheckResult, type OutboundEmailDomainDeleteResult, type OutboundEmailDomainUiStatus, type OutboundEmailDomainVerifyResult, type OutboundEmailDomainView, type OutboundEmailDomainsListResult, type PlatformSuppression, type PrerenderGetResult, type PrerenderInvalidateResult, type PrerenderPage, type PrerenderPagesResult, type PrerenderViewResult, type ReleaseFragment, type ReleasesByCommitResult, type ReleasesGetResult, type ReleasesListResult, type RequestsGetResult, type RequestsListResult, type RequestsListRow, type RequestsStatsMethodBucket, type RequestsStatsMethodResult, type RequestsStatsSummaryBucket, type RequestsStatsSummaryResult, type SecretsDeleteResult, type SecretsGetResult, type SecretsListResult, type SecretsSetResult, type SettingsResult, type SuppressionSource, type TrainingLogEntry, type TrainingRunRow, type TrainingRunStatus, type UserAuthProvider, type UserListItem, type UserRecord, type UsersCreateApiKeyResult, type UsersListResult, type UsersRevokeApiKeyResult, type UsersSetRoleResult, type V2AppSettings, type V2BuildLogEntry, type V2BuildStats, type V2CommitInfo, type V2EmailMessage, type V2ReleaseStatus, type VoiceAvailableNumber, type VoiceNumbersBuyResult, type VoiceNumbersListResult, type VoiceNumbersReleaseResult, type VoiceNumbersSearchResult, type VoiceNumbersSetNameResult, type VoicePhoneNumberStatus, type VoicePhoneNumberView, type VoiceResolvedPolicy, type VoiceSessionChannel, type VoiceSessionCost, type VoiceSessionCostLine, type VoiceSessionDetail, type VoiceSessionGetResult, type VoiceSessionListItem, type VoiceSessionSip, type VoiceSessionSpeechEntry, type VoiceSessionStatus, type VoiceSessionToolEntry, type VoiceSessionTranscriptEntry, type VoiceSessionsListResult, type VoiceSettingsCeilings, type VoiceSettingsGetResult, type VoiceSettingsOverrides, type VoiceSettingsSetResult, admin, createAdminClient, admin as default };
+export { AdminApiError, type AdminClient, type AdminClientOptions, type AdminContext, AdminTimeoutError, type AgentThreadDetail, type AgentThreadListItem, type AgentThreadsGetResult, type AgentThreadsListResult, type AgentToolCall, type AgentTranscriptMessage, type AgentTurnError, type AnalyticsAiHostRow, type AnalyticsAiSourcesResult, type AnalyticsAiVendorRow, type AnalyticsBatchResult, type AnalyticsCrawlersOverviewResult, type AnalyticsCrawlersRecentResult, type AnalyticsCrawlersRecentRow, type AnalyticsCrawlersResult, type AnalyticsCrawlersTimeseriesBucket, type AnalyticsCrawlersTimeseriesResult, type AnalyticsLiveResult, type AnalyticsMapPoint, type AnalyticsMapResult, type AnalyticsMetric, type AnalyticsQueryResult, type AnalyticsQueryResultRow, type AnalyticsSourceRow, type AnalyticsSourcesResult, type AppCronJobStatus, type AppCronJobStatusReason, type AppCronRunState, type AppEmailSuppression, type AppSecretRow, type CrashGroup, type CrashOccurrenceRow, type CrashesGetResult, type CrashesListResult, type CrashesOccurrencesResult, type CrashesStatsBucket, type CrashesStatsResult, type CronJobDecorated, type CronOverviewResult, type CronRunResult, type CronRunSummary, type DashboardLiveRelease, type DashboardReleaseMethod, type DashboardResult, type DataLiftFromDevResult, type DataLiftFromLiveResult, type DataSourcesBuildProgress, type DataSourcesChunkingConfig, type DataSourcesConfigResult, type DataSourcesConfigUpdateResult, type DataSourcesDeleteResult, type DataSourcesDocument, type DataSourcesDocumentConfirmResult, type DataSourcesDocumentDeleteResult, type DataSourcesDocumentStatus, type DataSourcesDocumentsResult, type DataSourcesDropResult, type DataSourcesIngestConfig, type DataSourcesIngestUpdate, type DataSourcesListEntry, type DataSourcesListResult, type DataSourcesPromoteResult, type DataSourcesRetrievalConfig, type DataSourcesRetrievalUpdate, type DataSourcesRevectorizeResult, type DataSourcesSearchCitation, type DataSourcesSearchResult, type DataSourcesSearchResultItem, type DataSourcesUploadTokenResult, type DatasetFile, type DbQueryResult, type DiagnosticsAuditEnvironment, type DiagnosticsDashboardResult, type DiagnosticsFinding, type DiagnosticsLighthouseScores, type DiagnosticsPayload, type DiagnosticsReleaseResult, type DiagnosticsRuntimeFindings, type DomainsCheckResult, type DomainsCustomAddResult, type DomainsCustomCheckResult, type DomainsCustomHostnameUiStatus, type DomainsCustomHostnameView, type DomainsCustomListResult, type DomainsCustomRemoveResult, type DomainsCustomRetryResult, type DomainsDnsInstructions, type DomainsGetResult, type DomainsSetResult, type EmailBatchLifecycle, type EmailBatchResult, type EmailBatchSummary, type EmailBatchesResult, type EmailDomainBase, type EmailEffectiveSender, type EmailInboxResult, type EmailListResult, type EmailMessageKind, type EmailMessageResult, type EmailMessageStatus, type EmailSenderTier, type EmailSendingStatusResult, type EmailStatsResult, type EmailSummary, type EmailSuppressResult, type EmailSuppressionsResult, type EmailUnsuppressResult, type EventChannelActivity, type EventsChannelsListResult, type EventsPublishResult, type EventsTailFrame, type FilesDeleteResult, type FilesFileMeta, type FilesListEntry, type FilesListResult, type FilesLsResult, type FilesScanBadge, type FilesScanFlagged, type FilesScanStore, type FilesStatResult, type FilesStoreSummaryEntry, type FilesUploadUrlResult, type FilesUrlResult, type FrontendErrorType, type InboundDnsInstructions, type InboundEmailDomainAddResult, type InboundEmailDomainCheckResult, type InboundEmailDomainDeleteResult, type InboundEmailDomainUiStatus, type InboundEmailDomainVerifyResult, type InboundEmailDomainView, type InboundEmailDomainsListResult, type InboxEmailPreview, type IssueAuthorKind, type IssueCommentRow, type IssueEventType, type IssueKind, type IssueRow, type IssueStatus, type IssuesCommentResult, type IssuesCreateResult, type IssuesDeleteResult, type IssuesGetResult, type IssuesListResult, type IssuesUpdateResult, type JewelPairRow, type JewelPairSummaryRow, type JewelVerdict, type JewelsDatasetSummary, type JewelsDryrunResult, type JewelsExportResult, type JewelsGradeResult, type JewelsGrading, type JewelsOverviewResult, type JewelsPairResult, type JewelsPairsResult, type JewelsQueueResult, type JewelsResolveResult, type JewelsRunResult, type JewelsRunsResult, type JewelsTimeseriesBucket, type JewelsTimeseriesResult, type JewelsTrainResult, type LiftedDatabase, type MethodsInvokeResult, type OutboundDnsInstructions, type OutboundEmailDomainAddResult, type OutboundEmailDomainCheckResult, type OutboundEmailDomainDeleteResult, type OutboundEmailDomainUiStatus, type OutboundEmailDomainVerifyResult, type OutboundEmailDomainView, type OutboundEmailDomainsListResult, type PlatformSuppression, type PrerenderGetResult, type PrerenderInvalidateResult, type PrerenderPage, type PrerenderPagesResult, type PrerenderViewResult, type ReleaseFragment, type ReleasesByCommitResult, type ReleasesGetResult, type ReleasesListResult, type RequestsGetResult, type RequestsListResult, type RequestsListRow, type RequestsStatsMethodBucket, type RequestsStatsMethodResult, type RequestsStatsSummaryBucket, type RequestsStatsSummaryResult, type SecretsDeleteResult, type SecretsGetResult, type SecretsListResult, type SecretsSetResult, type SettingsResult, type SuppressionSource, type TrainingLogEntry, type TrainingRunRow, type TrainingRunStatus, type UserAuthProvider, type UserListItem, type UserRecord, type UsersCreateApiKeyResult, type UsersListResult, type UsersRevokeApiKeyResult, type UsersSetRoleResult, type V2AppSettings, type V2BuildLogEntry, type V2BuildStats, type V2CommitInfo, type V2EmailMessage, type V2ReleaseStatus, type VoiceAvailableNumber, type VoiceNumbersBuyResult, type VoiceNumbersListResult, type VoiceNumbersReleaseResult, type VoiceNumbersSearchResult, type VoiceNumbersSetNameResult, type VoicePhoneNumberStatus, type VoicePhoneNumberView, type VoiceResolvedPolicy, type VoiceSessionChannel, type VoiceSessionCost, type VoiceSessionCostLine, type VoiceSessionDetail, type VoiceSessionGetResult, type VoiceSessionListItem, type VoiceSessionSip, type VoiceSessionSpeechEntry, type VoiceSessionStatus, type VoiceSessionToolEntry, type VoiceSessionTranscriptEntry, type VoiceSessionsListResult, type VoiceSettingsCeilings, type VoiceSettingsGetResult, type VoiceSettingsOverrides, type VoiceSettingsSetResult, admin, createAdminClient, admin as default };

package/dist/index.js

@@ -243,6 +243,28 @@ function crawlers(ctx, params) {
   );
 }
 
+// src/ops/events.ts
+var events_exports = {};
+__export(events_exports, {
+  channelsList: () => channelsList,
+  publish: () => publish
+});
+function channelsList(ctx, params = {}) {
+  return call(
+    ctx,
+    "GET",
+    `/_internal/v2/apps/${ctx.appId}/events/channels${qs(params)}`
+  );
+}
+function publish(ctx, params) {
+  return call(
+    ctx,
+    "POST",
+    `/_internal/v2/apps/${ctx.appId}/events/publish`,
+    { channels: params.channels, data: params.data, scope: params.scope }
+  );
+}
+
 // src/ops/crashes.ts
 var crashes_exports = {};
 __export(crashes_exports, {
@@ -1649,6 +1671,7 @@ function buildClient(ctx) {
     },
     agent: bindOps(agent_exports, ctx),
     analytics: bindOps(analytics_exports, ctx),
+    events: bindOps(events_exports, ctx),
     crashes: bindOps(crashes_exports, ctx),
     cron: bindOps(cron_exports, ctx),
     data: bindOps(data_exports, ctx),