freestyle-sync 0.1.0

package/src/plugin-api.ts

@@ -0,0 +1,107 @@
+export type CliOptions = {
+    projectRoot: string;
+    cachePath: string;
+    remoteProjectDir: string;
+    name: string;
+    vmId?: string;
+    idleTimeoutSeconds?: number;
+    yes: boolean;
+    dryRun: boolean;
+    disablePlugins: string[];
+    enablePlugins: string[];
+    resetPluginPrefs: boolean;
+    listPlugins: boolean;
+    includeAuth: boolean;
+    includeAgentContext: boolean;
+    includeGitDir: boolean;
+    includeAllCopilotWorkspaces: boolean;
+    snapshot: boolean;
+    install: boolean;
+    autoSsh: boolean;
+    envKeys: string[];
+};
+
+export type ContextCandidate = {
+    source: string;
+    remoteRoot: string;
+    label: string;
+    sensitive: boolean;
+    preferenceKey: string;
+    promptLabel: string;
+};
+
+export type RemoteVm = {
+    exec(args: { command: string; timeoutMs?: number }): Promise<{ stdout?: string | null; stderr?: string | null; statusCode?: number | null }>;
+    fs: {
+        writeFile(path: string, content: Buffer): Promise<void>;
+        writeTextFile(path: string, content: string): Promise<void>;
+    };
+};
+
+export type UploadArchiveInChunks = (
+    vm: RemoteVm,
+    vmId: string,
+    archivePath: string,
+    remoteArchivePath: string,
+    label: string,
+) => Promise<void>;
+
+export type ExecFileAsync = (file: string, args: string[]) => Promise<{ stdout: string; stderr: string }>;
+
+export type PushvmPluginUtils = {
+    checkedExec(vm: RemoteVm, command: string, timeoutMs?: number): Promise<{ stdout?: string | null; stderr?: string | null; statusCode?: number | null }>;
+    createTar(args: string[]): Promise<void>;
+    uploadArchiveInChunks: UploadArchiveInChunks;
+    execFileAsync: ExecFileAsync;
+    shellQuote(value: string): string;
+    md5(value: string): string;
+    delay(ms: number): Promise<void>;
+};
+
+export type PushvmPluginContext = {
+    options: CliOptions;
+    utils: PushvmPluginUtils;
+};
+
+export type RemoteHookContext = PushvmPluginContext & {
+    vm: RemoteVm;
+    vmId: string;
+};
+
+export type EditorHookContext = RemoteHookContext & {
+    scheme: "vscode" | "cursor";
+    remoteWorkspaceUri: string;
+};
+
+export type ConnectHookContext = RemoteHookContext & {
+    contextCandidates: ContextCandidate[];
+    runBeforeOpenRemoteEditor(args: { scheme: "vscode" | "cursor"; remoteWorkspaceUri: string }): Promise<string[]>;
+    runAfterOpenRemoteEditor(args: { scheme: "vscode" | "cursor"; remoteWorkspaceUri: string }): Promise<string[]>;
+};
+
+export type PushvmPlugin = {
+    name: string;
+    collectEnvironment?(context: PushvmPluginContext): Record<string, string>;
+    discoverContextCandidates?(context: PushvmPluginContext): Promise<ContextCandidate[]> | ContextCandidate[];
+    shouldSkipContextDirectory?(relativePath: string, name: string): boolean;
+    isProtectedRemotePath?(remotePath: string): boolean;
+    afterProjectSync?(context: RemoteHookContext): Promise<void> | void;
+    afterContextSync?(context: RemoteHookContext & { changedRemotePaths: string[] }): Promise<void> | void;
+    beforeSnapshot?(context: RemoteHookContext): Promise<void> | void;
+    afterSync?(context: RemoteHookContext & { contextCandidates: ContextCandidate[] }): Promise<string[] | void> | string[] | void;
+    connect?(context: ConnectHookContext): Promise<boolean | void> | boolean | void;
+    beforeOpenRemoteEditor?(context: EditorHookContext & { contextCandidates: ContextCandidate[] }): Promise<string[] | void> | string[] | void;
+    afterOpenRemoteEditor?(context: EditorHookContext & { contextCandidates: ContextCandidate[] }): Promise<string[] | void> | string[] | void;
+};
+
+export type PushvmConfig = {
+    plugins: PushvmPlugin[];
+};
+
+export function definePlugin(plugin: PushvmPlugin): PushvmPlugin {
+    return plugin;
+}
+
+export function defineConfig(config: PushvmConfig): PushvmConfig {
+    return config;
+}

package/tsconfig.json

@@ -0,0 +1,18 @@
+{
+  "compilerOptions": {
+    "target": "ES2022",
+    "module": "NodeNext",
+    "moduleResolution": "NodeNext",
+    "allowImportingTsExtensions": true,
+    "rewriteRelativeImportExtensions": true,
+    "strict": true,
+    "esModuleInterop": true,
+    "forceConsistentCasingInFileNames": true,
+    "skipLibCheck": true,
+    "types": ["node"],
+    "erasableSyntaxOnly": true,
+    "outDir": "dist",
+    "rootDir": "."
+  },
+  "include": ["freestyle-sync.config.ts", "src/**/*.ts", "plugins/**/*.ts"]
+}