@gpc-cli/plugin-sdk 0.1.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 GPC Contributors
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/dist/index.d.ts

@@ -0,0 +1,115 @@
+declare const PLUGIN_SDK_VERSION = "0.8.0";
+interface GpcPlugin {
+    /** Unique plugin name (e.g., "@gpc-cli/plugin-ci" or "gpc-plugin-slack") */
+    name: string;
+    /** Plugin version (semver) */
+    version: string;
+    /** Called once when the plugin is loaded. Register hooks here. */
+    register(hooks: PluginHooks): void | Promise<void>;
+}
+interface PluginHooks {
+    /** Run before a command executes. Can modify context or abort. */
+    beforeCommand(handler: BeforeCommandHandler): void;
+    /** Run after a command completes successfully. */
+    afterCommand(handler: AfterCommandHandler): void;
+    /** Run when a command fails with an error. */
+    onError(handler: ErrorHandler): void;
+    /** Run before each API request. Can inspect/modify request metadata. */
+    beforeRequest(handler: BeforeRequestHandler): void;
+    /** Run after each API response. Can inspect response metadata. */
+    afterResponse(handler: AfterResponseHandler): void;
+    /** Register additional CLI commands from the plugin. */
+    registerCommands(handler: CommandRegistrar): void;
+}
+type BeforeCommandHandler = (ctx: CommandEvent) => void | Promise<void>;
+type AfterCommandHandler = (ctx: CommandEvent, result: CommandResult) => void | Promise<void>;
+type ErrorHandler = (ctx: CommandEvent, error: PluginError) => void | Promise<void>;
+type BeforeRequestHandler = (req: RequestEvent) => void | Promise<void>;
+type AfterResponseHandler = (req: RequestEvent, res: ResponseEvent) => void | Promise<void>;
+type CommandRegistrar = (registry: CommandRegistry) => void;
+interface CommandEvent {
+    /** The command name (e.g., "releases upload", "vitals crashes") */
+    command: string;
+    /** Resolved arguments passed to the command */
+    args: Record<string, unknown>;
+    /** App package name (if available) */
+    app?: string;
+    /** Timestamp when the command started */
+    startedAt: Date;
+}
+interface CommandResult {
+    /** Whether the command succeeded */
+    success: boolean;
+    /** The output data (before formatting) */
+    data?: unknown;
+    /** Duration in milliseconds */
+    durationMs: number;
+    /** Exit code */
+    exitCode: number;
+}
+interface RequestEvent {
+    /** HTTP method (GET, POST, PUT, PATCH, DELETE) */
+    method: string;
+    /** Request path (relative to API base URL) */
+    path: string;
+    /** Timestamp when the request started */
+    startedAt: Date;
+}
+interface ResponseEvent {
+    /** HTTP status code */
+    status: number;
+    /** Duration in milliseconds */
+    durationMs: number;
+    /** Whether the response was successful (2xx) */
+    ok: boolean;
+}
+interface PluginError {
+    /** Error code */
+    code: string;
+    /** Error message */
+    message: string;
+    /** Exit code */
+    exitCode: number;
+    /** Original error (if available) */
+    cause?: Error;
+}
+interface CommandRegistry {
+    /** Add a new top-level command */
+    add(definition: PluginCommand): void;
+}
+interface PluginCommand {
+    /** Command name (e.g., "deploy") */
+    name: string;
+    /** Command description */
+    description: string;
+    /** Command options */
+    options?: PluginCommandOption[];
+    /** Command arguments */
+    arguments?: PluginCommandArgument[];
+    /** The action to run */
+    action: (args: Record<string, unknown>, options: Record<string, unknown>) => void | Promise<void>;
+}
+interface PluginCommandOption {
+    flags: string;
+    description: string;
+    defaultValue?: unknown;
+}
+interface PluginCommandArgument {
+    name: string;
+    description: string;
+    required?: boolean;
+}
+interface PluginManifest {
+    /** Plugin name */
+    name: string;
+    /** Plugin version */
+    version: string;
+    /** Required permissions */
+    permissions?: PluginPermission[];
+    /** Whether this is a first-party (@gpc-cli/*) plugin */
+    trusted?: boolean;
+}
+type PluginPermission = "read:config" | "write:config" | "read:auth" | "api:read" | "api:write" | "commands:register" | "hooks:beforeCommand" | "hooks:afterCommand" | "hooks:onError" | "hooks:beforeRequest" | "hooks:afterResponse";
+declare function definePlugin(plugin: GpcPlugin): GpcPlugin;
+
+export { type AfterCommandHandler, type AfterResponseHandler, type BeforeCommandHandler, type BeforeRequestHandler, type CommandEvent, type CommandRegistrar, type CommandRegistry, type CommandResult, type ErrorHandler, type GpcPlugin, PLUGIN_SDK_VERSION, type PluginCommand, type PluginCommandArgument, type PluginCommandOption, type PluginError, type PluginHooks, type PluginManifest, type PluginPermission, type RequestEvent, type ResponseEvent, definePlugin };

package/dist/index.js

@@ -0,0 +1,10 @@
+// src/index.ts
+var PLUGIN_SDK_VERSION = "0.8.0";
+function definePlugin(plugin) {
+  return plugin;
+}
+export {
+  PLUGIN_SDK_VERSION,
+  definePlugin
+};
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../src/index.ts"],"sourcesContent":["export const PLUGIN_SDK_VERSION = \"0.8.0\";\n\n// ---------------------------------------------------------------------------\n// Plugin interface\n// ---------------------------------------------------------------------------\n\nexport interface GpcPlugin {\n  /** Unique plugin name (e.g., \"@gpc-cli/plugin-ci\" or \"gpc-plugin-slack\") */\n  name: string;\n\n  /** Plugin version (semver) */\n  version: string;\n\n  /** Called once when the plugin is loaded. Register hooks here. */\n  register(hooks: PluginHooks): void | Promise<void>;\n}\n\n// ---------------------------------------------------------------------------\n// Lifecycle hooks\n// ---------------------------------------------------------------------------\n\nexport interface PluginHooks {\n  /** Run before a command executes. Can modify context or abort. */\n  beforeCommand(handler: BeforeCommandHandler): void;\n\n  /** Run after a command completes successfully. */\n  afterCommand(handler: AfterCommandHandler): void;\n\n  /** Run when a command fails with an error. */\n  onError(handler: ErrorHandler): void;\n\n  /** Run before each API request. Can inspect/modify request metadata. */\n  beforeRequest(handler: BeforeRequestHandler): void;\n\n  /** Run after each API response. Can inspect response metadata. */\n  afterResponse(handler: AfterResponseHandler): void;\n\n  /** Register additional CLI commands from the plugin. */\n  registerCommands(handler: CommandRegistrar): void;\n}\n\nexport type BeforeCommandHandler = (ctx: CommandEvent) => void | Promise<void>;\nexport type AfterCommandHandler = (ctx: CommandEvent, result: CommandResult) => void | Promise<void>;\nexport type ErrorHandler = (ctx: CommandEvent, error: PluginError) => void | Promise<void>;\nexport type BeforeRequestHandler = (req: RequestEvent) => void | Promise<void>;\nexport type AfterResponseHandler = (req: RequestEvent, res: ResponseEvent) => void | Promise<void>;\nexport type CommandRegistrar = (registry: CommandRegistry) => void;\n\n// ---------------------------------------------------------------------------\n// Event types\n// ---------------------------------------------------------------------------\n\nexport interface CommandEvent {\n  /** The command name (e.g., \"releases upload\", \"vitals crashes\") */\n  command: string;\n\n  /** Resolved arguments passed to the command */\n  args: Record<string, unknown>;\n\n  /** App package name (if available) */\n  app?: string;\n\n  /** Timestamp when the command started */\n  startedAt: Date;\n}\n\nexport interface CommandResult {\n  /** Whether the command succeeded */\n  success: boolean;\n\n  /** The output data (before formatting) */\n  data?: unknown;\n\n  /** Duration in milliseconds */\n  durationMs: number;\n\n  /** Exit code */\n  exitCode: number;\n}\n\n// ---------------------------------------------------------------------------\n// Request/response events (for beforeRequest/afterResponse hooks)\n// ---------------------------------------------------------------------------\n\nexport interface RequestEvent {\n  /** HTTP method (GET, POST, PUT, PATCH, DELETE) */\n  method: string;\n\n  /** Request path (relative to API base URL) */\n  path: string;\n\n  /** Timestamp when the request started */\n  startedAt: Date;\n}\n\nexport interface ResponseEvent {\n  /** HTTP status code */\n  status: number;\n\n  /** Duration in milliseconds */\n  durationMs: number;\n\n  /** Whether the response was successful (2xx) */\n  ok: boolean;\n}\n\n// ---------------------------------------------------------------------------\n// Error types\n// ---------------------------------------------------------------------------\n\nexport interface PluginError {\n  /** Error code */\n  code: string;\n\n  /** Error message */\n  message: string;\n\n  /** Exit code */\n  exitCode: number;\n\n  /** Original error (if available) */\n  cause?: Error;\n}\n\n// ---------------------------------------------------------------------------\n// Command registry (for plugins that add commands)\n// ---------------------------------------------------------------------------\n\nexport interface CommandRegistry {\n  /** Add a new top-level command */\n  add(definition: PluginCommand): void;\n}\n\nexport interface PluginCommand {\n  /** Command name (e.g., \"deploy\") */\n  name: string;\n\n  /** Command description */\n  description: string;\n\n  /** Command options */\n  options?: PluginCommandOption[];\n\n  /** Command arguments */\n  arguments?: PluginCommandArgument[];\n\n  /** The action to run */\n  action: (args: Record<string, unknown>, options: Record<string, unknown>) => void | Promise<void>;\n}\n\nexport interface PluginCommandOption {\n  flags: string;\n  description: string;\n  defaultValue?: unknown;\n}\n\nexport interface PluginCommandArgument {\n  name: string;\n  description: string;\n  required?: boolean;\n}\n\n// ---------------------------------------------------------------------------\n// Plugin metadata (for discovery and permission checks)\n// ---------------------------------------------------------------------------\n\nexport interface PluginManifest {\n  /** Plugin name */\n  name: string;\n\n  /** Plugin version */\n  version: string;\n\n  /** Required permissions */\n  permissions?: PluginPermission[];\n\n  /** Whether this is a first-party (@gpc-cli/*) plugin */\n  trusted?: boolean;\n}\n\nexport type PluginPermission =\n  | \"read:config\"\n  | \"write:config\"\n  | \"read:auth\"\n  | \"api:read\"\n  | \"api:write\"\n  | \"commands:register\"\n  | \"hooks:beforeCommand\"\n  | \"hooks:afterCommand\"\n  | \"hooks:onError\"\n  | \"hooks:beforeRequest\"\n  | \"hooks:afterResponse\";\n\n// ---------------------------------------------------------------------------\n// Helper to define a plugin (for plugin authors)\n// ---------------------------------------------------------------------------\n\nexport function definePlugin(plugin: GpcPlugin): GpcPlugin {\n  return plugin;\n}\n"],"mappings":";AAAO,IAAM,qBAAqB;AAqM3B,SAAS,aAAa,QAA8B;AACzD,SAAO;AACT;","names":[]}

package/package.json

@@ -0,0 +1,32 @@
+{
+  "name": "@gpc-cli/plugin-sdk",
+  "version": "0.1.0",
+  "description": "Plugin interface and SDK for extending GPC",
+  "type": "module",
+  "main": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "exports": {
+    ".": {
+      "import": "./dist/index.js",
+      "types": "./dist/index.d.ts"
+    }
+  },
+  "files": [
+    "dist"
+  ],
+  "keywords": [
+    "google-play",
+    "plugin",
+    "sdk"
+  ],
+  "license": "MIT",
+  "scripts": {
+    "build": "tsup",
+    "dev": "tsup --watch",
+    "test": "vitest run",
+    "test:watch": "vitest",
+    "lint": "eslint src/",
+    "typecheck": "tsc --noEmit",
+    "clean": "rm -rf dist"
+  }
+}