@gpc-cli/core 0.9.5 → 0.9.7

package/dist/index.d.ts

@@ -1,7 +1,7 @@
-import { OutputFormat, ResolvedConfig } from '@gpc-cli/config';
+import { OutputFormat, ResolvedConfig, WebhookConfig } from '@gpc-cli/config';
 import { AuthClient } from '@gpc-cli/auth';
 import { GpcPlugin, PluginManifest, CommandEvent, CommandResult, PluginError, RequestEvent, ResponseEvent, PluginCommand } from '@gpc-cli/plugin-sdk';
-import { PlayApiClient, Track, Listing, ImageType, CountryAvailability, Image, AppDetails, Review, ReviewReplyResponse, Subscription, SubscriptionOffer, OffersListResponse, BasePlanMigratePricesRequest, InAppProduct, SubscriptionDeferResponse, ProductPurchase, SubscriptionPurchaseV2, VoidedPurchase, UsersApiClient, User, DeveloperPermission, Grant, MetricRow, ReportingDimension, ReportingAggregation, ReportingApiClient, VitalsMetricSet, AnomalyDetectionResponse, MetricSetResponse, ErrorIssuesResponse, ConvertRegionPricesResponse, ReportType, StatsDimension, ReportBucket, Testers } from '@gpc-cli/api';
+import { PlayApiClient, Track, Listing, ImageType, CountryAvailability, Image, AppDetails, Review, ReviewReplyResponse, Subscription, SubscriptionOffer, OffersListResponse, BasePlanMigratePricesRequest, InAppProduct, SubscriptionDeferResponse, ProductPurchase, SubscriptionPurchaseV2, VoidedPurchase, UsersApiClient, User, DeveloperPermission, Grant, MetricRow, ReportingDimension, ReportingAggregation, ReportingApiClient, VitalsMetricSet, AnomalyDetectionResponse, MetricSetResponse, ErrorIssuesResponse, ConvertRegionPricesResponse, ReportType, StatsDimension, ReportBucket, Testers, AppRecoveryAction, DataSafety, ExternalTransaction, ExternalTransactionRefund } from '@gpc-cli/api';
 
 declare class GpcError extends Error {
     readonly code: string;
@@ -113,6 +113,25 @@ interface ReleaseStatusResult {
         text: string;
     }[];
 }
+interface DryRunUploadResult {
+    dryRun: true;
+    file: {
+        path: string;
+        valid: boolean;
+        errors: string[];
+        warnings: string[];
+    };
+    track: string;
+    currentReleases: {
+        versionCodes: string[];
+        status: string;
+        userFraction?: number;
+    }[];
+    plannedRelease: {
+        status: string;
+        userFraction?: number;
+    };
+}
 declare function uploadRelease(client: PlayApiClient, packageName: string, filePath: string, options: {
     track: string;
     status?: string;
@@ -123,7 +142,8 @@ declare function uploadRelease(client: PlayApiClient, packageName: string, fileP
     }[];
     releaseName?: string;
     mappingFile?: string;
-}): Promise<UploadResult>;
+    dryRun?: boolean;
+}): Promise<UploadResult | DryRunUploadResult>;
 declare function getReleasesStatus(client: PlayApiClient, packageName: string, trackFilter?: string): Promise<ReleaseStatusResult[]>;
 declare function promoteRelease(client: PlayApiClient, packageName: string, fromTrack: string, toTrack: string, options?: {
     userFraction?: number;
@@ -165,6 +185,7 @@ declare function pushListings(client: PlayApiClient, packageName: string, dir: s
 declare function listImages(client: PlayApiClient, packageName: string, language: string, imageType: ImageType): Promise<Image[]>;
 declare function uploadImage(client: PlayApiClient, packageName: string, language: string, imageType: ImageType, filePath: string): Promise<Image>;
 declare function deleteImage(client: PlayApiClient, packageName: string, language: string, imageType: ImageType, imageId: string): Promise<void>;
+declare function diffListingsCommand(client: PlayApiClient, packageName: string, dir: string): Promise<ListingDiff[]>;
 declare function getCountryAvailability(client: PlayApiClient, packageName: string, track: string): Promise<CountryAvailability>;
 declare function updateAppDetails(client: PlayApiClient, packageName: string, details: Partial<AppDetails>): Promise<AppDetails>;
 
@@ -220,12 +241,18 @@ interface PublishOptions {
     notesDir?: string;
     releaseName?: string;
     mappingFile?: string;
+    dryRun?: boolean;
 }
 interface PublishResult {
     validation: ValidateResult;
     upload?: UploadResult;
 }
-declare function publish(client: PlayApiClient, packageName: string, filePath: string, options: PublishOptions): Promise<PublishResult>;
+interface DryRunPublishResult {
+    dryRun: true;
+    validation: ValidateResult;
+    upload: DryRunUploadResult;
+}
+declare function publish(client: PlayApiClient, packageName: string, filePath: string, options: PublishOptions): Promise<PublishResult | DryRunPublishResult>;
 
 interface ReviewsFilterOptions {
     stars?: number;
@@ -404,6 +431,32 @@ declare function importTestersFromCsv(client: PlayApiClient, packageName: string
     testers: Testers;
 }>;
 
+interface GitNotesOptions {
+    since?: string;
+    language?: string;
+    maxLength?: number;
+}
+interface GitReleaseNotes {
+    language: string;
+    text: string;
+    commitCount: number;
+    since: string;
+}
+declare function generateNotesFromGit(options?: GitNotesOptions): Promise<GitReleaseNotes>;
+
+declare function listRecoveryActions(client: PlayApiClient, packageName: string): Promise<AppRecoveryAction[]>;
+declare function cancelRecoveryAction(client: PlayApiClient, packageName: string, recoveryId: string): Promise<void>;
+declare function deployRecoveryAction(client: PlayApiClient, packageName: string, recoveryId: string): Promise<void>;
+
+declare function getDataSafety(client: PlayApiClient, packageName: string): Promise<DataSafety>;
+declare function updateDataSafety(client: PlayApiClient, packageName: string, data: DataSafety): Promise<DataSafety>;
+declare function exportDataSafety(client: PlayApiClient, packageName: string, outputPath: string): Promise<DataSafety>;
+declare function importDataSafety(client: PlayApiClient, packageName: string, filePath: string): Promise<DataSafety>;
+
+declare function createExternalTransaction(client: PlayApiClient, packageName: string, data: ExternalTransaction): Promise<ExternalTransaction>;
+declare function getExternalTransaction(client: PlayApiClient, packageName: string, transactionId: string): Promise<ExternalTransaction>;
+declare function refundExternalTransaction(client: PlayApiClient, packageName: string, transactionId: string, refundData: ExternalTransactionRefund): Promise<ExternalTransaction>;
+
 /**
  * Normalize and resolve a user-supplied path.
  * Prevents path traversal by normalizing `.` and `..` components.
@@ -415,6 +468,23 @@ declare function safePath(userPath: string): string;
  */
 declare function safePathWithin(userPath: string, baseDir: string): string;
 
+/**
+ * Sort utility for CLI list command results.
+ *
+ * Supports ascending (field) and descending (-field) sort specs,
+ * including dot notation for nested fields (e.g., "comments.userComment.starRating").
+ */
+/**
+ * Sort an array of items by a field specification.
+ *
+ * @param items - Array to sort (not mutated; returns a new array)
+ * @param sortSpec - Field name for ascending, or `-field` for descending.
+ *                   Supports dot notation for nested fields.
+ *                   If undefined/empty, returns items in original order.
+ * @returns Sorted copy of items
+ */
+declare function sortResults<T>(items: T[], sortSpec?: string): T[];
+
 interface ScaffoldOptions {
     name: string;
     dir: string;
@@ -453,4 +523,17 @@ declare function writeAuditLog(entry: AuditEntry): Promise<void>;
  */
 declare function createAuditEntry(command: string, args: Record<string, unknown>, app?: string): AuditEntry;
 
-export { ApiError, type AppInfo, type AuditEntry, type CommandContext, ConfigError, type DiscoverPluginsOptions, type DryRunResult, type FileValidationResult, GOOGLE_PLAY_LANGUAGES, GpcError, type ImageValidationResult, type ListIapOptions, type ListSubscriptionsOptions, type ListUsersOptions, type ListVoidedOptions, type ListingDiff, type ListingsResult, type LoadedPlugin, NetworkError, PERMISSION_PROPAGATION_WARNING, type ParsedMonth, PluginManager, type PublishOptions, type PublishResult, type PushResult, type ReleaseNotesValidation, type ReleaseStatusResult, type ReviewExportOptions, type ReviewsFilterOptions, type ScaffoldOptions, type ScaffoldResult, type SyncResult, type ThresholdResult, type UploadResult, type ValidateCheck, type ValidateOptions, type ValidateResult, type VitalsOverview, type VitalsQueryOptions, type VitalsTrendComparison, acknowledgeProductPurchase, activateBasePlan, activateOffer, addTesters, cancelSubscriptionPurchase, checkThreshold, compareVitalsTrend, consumeProductPurchase, convertRegionPrices, createAuditEntry, createInAppProduct, createOffer, createSubscription, deactivateBasePlan, deactivateOffer, deferSubscriptionPurchase, deleteBasePlan, deleteImage, deleteInAppProduct, deleteListing, deleteOffer, deleteSubscription, detectOutputFormat, diffListings, discoverPlugins, downloadReport, exportReviews, formatOutput, getAppInfo, getCountryAvailability, getInAppProduct, getListings, getOffer, getProductPurchase, getReleasesStatus, getReview, getSubscription, getSubscriptionPurchase, getUser, getVitalsAnomalies, getVitalsAnr, getVitalsBattery, getVitalsCrashes, getVitalsMemory, getVitalsOverview, getVitalsRendering, getVitalsStartup, importTestersFromCsv, initAudit, inviteUser, isFinancialReportType, isStatsReportType, isValidBcp47, isValidReportType, isValidStatsDimension, listImages, listInAppProducts, listOffers, listReports, listReviews, listSubscriptions, listTesters, listTracks, listUsers, listVoidedPurchases, migratePrices, parseGrantArg, parseMonth, promoteRelease, publish, pullListings, pushListings, readListingsFromDir, readReleaseNotesFromDir, redactSensitive, refundOrder, removeTesters, removeUser, replyToReview, revokeSubscriptionPurchase, safePath, safePathWithin, scaffoldPlugin, searchVitalsErrors, syncInAppProducts, updateAppDetails, updateInAppProduct, updateListing, updateOffer, updateRollout, updateSubscription, updateUser, uploadImage, uploadRelease, validateImage, validatePreSubmission, validateReleaseNotes, validateUploadFile, writeAuditLog, writeListingsToDir };
+interface WebhookPayload {
+    command: string;
+    success: boolean;
+    duration: number;
+    app?: string;
+    details?: Record<string, unknown>;
+    error?: string;
+}
+declare function formatSlackPayload(payload: WebhookPayload): object;
+declare function formatDiscordPayload(payload: WebhookPayload): object;
+declare function formatCustomPayload(payload: WebhookPayload): object;
+declare function sendWebhook(config: WebhookConfig, payload: WebhookPayload, target?: string): Promise<void>;
+
+export { ApiError, type AppInfo, type AuditEntry, type CommandContext, ConfigError, type DiscoverPluginsOptions, type DryRunPublishResult, type DryRunResult, type DryRunUploadResult, type FileValidationResult, GOOGLE_PLAY_LANGUAGES, type GitNotesOptions, type GitReleaseNotes, GpcError, type ImageValidationResult, type ListIapOptions, type ListSubscriptionsOptions, type ListUsersOptions, type ListVoidedOptions, type ListingDiff, type ListingsResult, type LoadedPlugin, NetworkError, PERMISSION_PROPAGATION_WARNING, type ParsedMonth, PluginManager, type PublishOptions, type PublishResult, type PushResult, type ReleaseNotesValidation, type ReleaseStatusResult, type ReviewExportOptions, type ReviewsFilterOptions, type ScaffoldOptions, type ScaffoldResult, type SyncResult, type ThresholdResult, type UploadResult, type ValidateCheck, type ValidateOptions, type ValidateResult, type VitalsOverview, type VitalsQueryOptions, type VitalsTrendComparison, type WebhookPayload, acknowledgeProductPurchase, activateBasePlan, activateOffer, addTesters, cancelRecoveryAction, cancelSubscriptionPurchase, checkThreshold, compareVitalsTrend, consumeProductPurchase, convertRegionPrices, createAuditEntry, createExternalTransaction, createInAppProduct, createOffer, createSubscription, deactivateBasePlan, deactivateOffer, deferSubscriptionPurchase, deleteBasePlan, deleteImage, deleteInAppProduct, deleteListing, deleteOffer, deleteSubscription, deployRecoveryAction, detectOutputFormat, diffListings, diffListingsCommand, discoverPlugins, downloadReport, exportDataSafety, exportReviews, formatCustomPayload, formatDiscordPayload, formatOutput, formatSlackPayload, generateNotesFromGit, getAppInfo, getCountryAvailability, getDataSafety, getExternalTransaction, getInAppProduct, getListings, getOffer, getProductPurchase, getReleasesStatus, getReview, getSubscription, getSubscriptionPurchase, getUser, getVitalsAnomalies, getVitalsAnr, getVitalsBattery, getVitalsCrashes, getVitalsMemory, getVitalsOverview, getVitalsRendering, getVitalsStartup, importDataSafety, importTestersFromCsv, initAudit, inviteUser, isFinancialReportType, isStatsReportType, isValidBcp47, isValidReportType, isValidStatsDimension, listImages, listInAppProducts, listOffers, listRecoveryActions, listReports, listReviews, listSubscriptions, listTesters, listTracks, listUsers, listVoidedPurchases, migratePrices, parseGrantArg, parseMonth, promoteRelease, publish, pullListings, pushListings, readListingsFromDir, readReleaseNotesFromDir, redactSensitive, refundExternalTransaction, refundOrder, removeTesters, removeUser, replyToReview, revokeSubscriptionPurchase, safePath, safePathWithin, scaffoldPlugin, searchVitalsErrors, sendWebhook, sortResults, syncInAppProducts, updateAppDetails, updateDataSafety, updateInAppProduct, updateListing, updateOffer, updateRollout, updateSubscription, updateUser, uploadImage, uploadRelease, validateImage, validatePreSubmission, validateReleaseNotes, validateUploadFile, writeAuditLog, writeListingsToDir };