gitx.do 0.1.0 → 0.1.2

package/dist/do/withGit.d.ts

@@ -1,180 +0,0 @@
-/**
- * @fileoverview withGit Mixin Function for DO Composition
- *
- * This module provides a mixin function that adds git capability to any
- * Durable Object class. The mixin supports lazy initialization of the
- * GitModule for optimal performance.
- *
- * @module do/withGit
- *
- * @example
- * ```typescript
- * import { withGit } from 'gitx.do/do'
- * import { DO } from 'dotdo'
- *
- * // Basic usage - adds this.git property
- * class MyDO extends withGit(DO, { repo: 'org/repo' }) {
- *   async handleRequest() {
- *     await this.git.sync()
- *     const status = await this.git.status()
- *     return new Response(JSON.stringify(status))
- *   }
- * }
- *
- * // With $.git context integration
- * class WorkflowDO extends withGit(DO, {
- *   repo: 'org/repo',
- *   contextMode: true
- * }) {
- *   async handleRequest() {
- *     // Access via $.git when contextMode is enabled
- *     await this.$.git.sync()
- *   }
- * }
- * ```
- */
-import { GitModule, type GitModuleOptions, type GitBinding, type GitStatus, type SyncResult, type PushResult, type FsCapability, type R2BucketLike } from './GitModule';
-/**
- * Type for a class constructor.
- * @template T - The type that the constructor creates
- */
-export type Constructor<T = object> = new (...args: any[]) => T;
-/**
- * Interface for DOs that have git capability.
- * This is the shape of a class after applying the withGit mixin.
- */
-export interface WithGitCapability {
-    /** The GitModule instance providing git operations */
-    git: GitModule;
-}
-/**
- * Interface for the extended WorkflowContext with git capability.
- * Used when contextMode is enabled.
- */
-export interface WithGitContext {
-    git: GitModule;
-    [key: string]: unknown;
-}
-/**
- * Configuration options for the withGit mixin.
- */
-export interface WithGitOptions {
-    /**
-     * Repository identifier (e.g., 'org/repo' or full URL)
-     */
-    repo: string;
-    /**
-     * Branch to track
-     * @default 'main'
-     */
-    branch?: string;
-    /**
-     * Path prefix within the repository
-     */
-    path?: string;
-    /**
-     * R2 binding name in env to use for object storage
-     * @default 'R2_BUCKET'
-     */
-    r2Binding?: string;
-    /**
-     * Custom object key prefix in R2
-     * @default 'git/objects'
-     */
-    objectPrefix?: string;
-    /**
-     * Whether to extend the $ WorkflowContext with git capability.
-     * When true, this.$.git will be available in addition to this.git.
-     * @default false
-     */
-    contextMode?: boolean;
-    /**
-     * Whether to auto-initialize the GitModule on construction.
-     * When false (default), GitModule is lazily initialized on first access.
-     * @default false
-     */
-    autoInit?: boolean;
-}
-/**
- * Mixin function to add git capability to a DO class.
- *
- * @description
- * Composes git functionality into a Durable Object class using the mixin pattern.
- * The resulting class will have a `git` property that provides GitModule functionality.
- *
- * Features:
- * - Lazy initialization: GitModule is only created when first accessed
- * - R2 integration: Automatically resolves R2 bucket from env bindings
- * - Context mode: Optionally extends the $ WorkflowContext with git capability
- * - Composable: Can be combined with other mixins like withBash
- *
- * @param Base - Base class to extend
- * @param options - Git configuration options
- * @returns Extended class with git capability
- *
- * @example
- * ```typescript
- * // Basic usage
- * import { withGit } from 'gitx.do/do'
- * import { DO } from 'dotdo'
- *
- * class MyDO extends withGit(DO, { repo: 'org/repo' }) {
- *   async syncAndCommit() {
- *     await this.git.sync()
- *     await this.git.add('.')
- *     await this.git.commit('Update files')
- *     await this.git.push()
- *   }
- * }
- * ```
- *
- * @example
- * ```typescript
- * // With custom R2 binding
- * class MyDO extends withGit(DO, {
- *   repo: 'org/repo',
- *   branch: 'develop',
- *   r2Binding: 'GIT_OBJECTS'
- * }) {
- *   async handleRequest() {
- *     await this.git.sync()
- *     return new Response('Synced!')
- *   }
- * }
- * ```
- *
- * @example
- * ```typescript
- * // Composing with other mixins
- * import { withGit, withBash } from 'gitx.do/do'
- *
- * class DevDO extends withBash(withGit(DO, { repo: 'org/repo' }), {
- *   cwd: '/workspace'
- * }) {
- *   async buildAndPush() {
- *     await this.git.sync()
- *     await this.bash.exec('npm', ['run', 'build'])
- *     await this.git.add('dist/')
- *     await this.git.commit('Build: update dist')
- *     await this.git.push()
- *   }
- * }
- * ```
- */
-export declare function withGit<TBase extends Constructor>(Base: TBase, options: WithGitOptions): TBase & Constructor<WithGitCapability>;
-/**
- * Check if a value has git capability.
- *
- * @param value - Value to check
- * @returns True if value has the git property and it's a GitModule
- *
- * @example
- * ```typescript
- * if (hasGitCapability(instance)) {
- *   await instance.git.sync()
- * }
- * ```
- */
-export declare function hasGitCapability(value: unknown): value is WithGitCapability;
-export { GitModule, type GitModuleOptions, type GitBinding, type GitStatus, type SyncResult, type PushResult, type FsCapability, type R2BucketLike, };
-//# sourceMappingURL=withGit.d.ts.map

package/dist/do/withGit.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"withGit.d.ts","sourceRoot":"","sources":["../../src/do/withGit.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAkCG;AAEH,OAAO,EACL,SAAS,EACT,KAAK,gBAAgB,EACrB,KAAK,UAAU,EACf,KAAK,SAAS,EACd,KAAK,UAAU,EACf,KAAK,UAAU,EACf,KAAK,YAAY,EACjB,KAAK,YAAY,EAClB,MAAM,aAAa,CAAA;AAMpB;;;GAGG;AAEH,MAAM,MAAM,WAAW,CAAC,CAAC,GAAG,MAAM,IAAI,KAAK,GAAG,IAAI,EAAE,GAAG,EAAE,KAAK,CAAC,CAAA;AAE/D;;;GAGG;AACH,MAAM,WAAW,iBAAiB;IAChC,sDAAsD;IACtD,GAAG,EAAE,SAAS,CAAA;CACf;AAED;;;GAGG;AACH,MAAM,WAAW,cAAc;IAC7B,GAAG,EAAE,SAAS,CAAA;IACd,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;CACvB;AAED;;GAEG;AACH,MAAM,WAAW,cAAc;IAC7B;;OAEG;IACH,IAAI,EAAE,MAAM,CAAA;IAEZ;;;OAGG;IACH,MAAM,CAAC,EAAE,MAAM,CAAA;IAEf;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAA;IAEb;;;OAGG;IACH,SAAS,CAAC,EAAE,MAAM,CAAA;IAElB;;;OAGG;IACH,YAAY,CAAC,EAAE,MAAM,CAAA;IAErB;;;;OAIG;IACH,WAAW,CAAC,EAAE,OAAO,CAAA;IAErB;;;;OAIG;IACH,QAAQ,CAAC,EAAE,OAAO,CAAA;CACnB;AA8BD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAiEG;AACH,wBAAgB,OAAO,CAAC,KAAK,SAAS,WAAW,EAC/C,IAAI,EAAE,KAAK,EACX,OAAO,EAAE,cAAc,GACtB,KAAK,GAAG,WAAW,CAAC,iBAAiB,CAAC,CA+IxC;AAMD;;;;;;;;;;;;GAYG;AACH,wBAAgB,gBAAgB,CAAC,KAAK,EAAE,OAAO,GAAG,KAAK,IAAI,iBAAiB,CAO3E;AAMD,OAAO,EACL,SAAS,EACT,KAAK,gBAAgB,EACrB,KAAK,UAAU,EACf,KAAK,SAAS,EACd,KAAK,UAAU,EACf,KAAK,UAAU,EACf,KAAK,YAAY,EACjB,KAAK,YAAY,GAClB,CAAA"}

package/dist/do/withGit.js

@@ -1,271 +0,0 @@
-/**
- * @fileoverview withGit Mixin Function for DO Composition
- *
- * This module provides a mixin function that adds git capability to any
- * Durable Object class. The mixin supports lazy initialization of the
- * GitModule for optimal performance.
- *
- * @module do/withGit
- *
- * @example
- * ```typescript
- * import { withGit } from 'gitx.do/do'
- * import { DO } from 'dotdo'
- *
- * // Basic usage - adds this.git property
- * class MyDO extends withGit(DO, { repo: 'org/repo' }) {
- *   async handleRequest() {
- *     await this.git.sync()
- *     const status = await this.git.status()
- *     return new Response(JSON.stringify(status))
- *   }
- * }
- *
- * // With $.git context integration
- * class WorkflowDO extends withGit(DO, {
- *   repo: 'org/repo',
- *   contextMode: true
- * }) {
- *   async handleRequest() {
- *     // Access via $.git when contextMode is enabled
- *     await this.$.git.sync()
- *   }
- * }
- * ```
- */
-import { GitModule, } from './GitModule';
-// ============================================================================
-// Symbol for Lazy Initialization Cache
-// ============================================================================
-/**
- * Symbol key for caching the GitModule instance.
- * Using a symbol prevents property name collisions.
- */
-const GIT_MODULE_CACHE = Symbol('gitModuleCache');
-/**
- * Symbol key for storing resolved options.
- */
-const GIT_OPTIONS = Symbol('gitOptions');
-// ============================================================================
-// withGit Mixin Function
-// ============================================================================
-/**
- * Mixin function to add git capability to a DO class.
- *
- * @description
- * Composes git functionality into a Durable Object class using the mixin pattern.
- * The resulting class will have a `git` property that provides GitModule functionality.
- *
- * Features:
- * - Lazy initialization: GitModule is only created when first accessed
- * - R2 integration: Automatically resolves R2 bucket from env bindings
- * - Context mode: Optionally extends the $ WorkflowContext with git capability
- * - Composable: Can be combined with other mixins like withBash
- *
- * @param Base - Base class to extend
- * @param options - Git configuration options
- * @returns Extended class with git capability
- *
- * @example
- * ```typescript
- * // Basic usage
- * import { withGit } from 'gitx.do/do'
- * import { DO } from 'dotdo'
- *
- * class MyDO extends withGit(DO, { repo: 'org/repo' }) {
- *   async syncAndCommit() {
- *     await this.git.sync()
- *     await this.git.add('.')
- *     await this.git.commit('Update files')
- *     await this.git.push()
- *   }
- * }
- * ```
- *
- * @example
- * ```typescript
- * // With custom R2 binding
- * class MyDO extends withGit(DO, {
- *   repo: 'org/repo',
- *   branch: 'develop',
- *   r2Binding: 'GIT_OBJECTS'
- * }) {
- *   async handleRequest() {
- *     await this.git.sync()
- *     return new Response('Synced!')
- *   }
- * }
- * ```
- *
- * @example
- * ```typescript
- * // Composing with other mixins
- * import { withGit, withBash } from 'gitx.do/do'
- *
- * class DevDO extends withBash(withGit(DO, { repo: 'org/repo' }), {
- *   cwd: '/workspace'
- * }) {
- *   async buildAndPush() {
- *     await this.git.sync()
- *     await this.bash.exec('npm', ['run', 'build'])
- *     await this.git.add('dist/')
- *     await this.git.commit('Build: update dist')
- *     await this.git.push()
- *   }
- * }
- * ```
- */
-export function withGit(Base, options) {
-    // Validate required options
-    if (!options.repo) {
-        throw new Error('withGit: repo option is required');
-    }
-    return class WithGitMixin extends Base {
-        /**
-         * Static list of capabilities for introspection.
-         */
-        static capabilities = [...(Base.capabilities || []), 'git'];
-        /**
-         * Cached GitModule instance (lazy initialized).
-         */
-        [GIT_MODULE_CACHE];
-        /**
-         * Resolved options for GitModule creation.
-         */
-        [GIT_OPTIONS];
-        /**
-         * Whether the git module has been initialized.
-         */
-        gitInitialized = false;
-        /**
-         * The git property provides access to the GitModule.
-         * Implements lazy initialization - the module is only created
-         * when this property is first accessed.
-         */
-        get git() {
-            if (!this[GIT_MODULE_CACHE]) {
-                this[GIT_MODULE_CACHE] = this.createGitModule();
-            }
-            return this[GIT_MODULE_CACHE];
-        }
-        /**
-         * Check if this DO class has a specific capability.
-         * @param name - Capability name to check
-         * @returns True if the capability is available
-         */
-        hasCapability(name) {
-            if (name === 'git')
-                return true;
-            // Check if parent class has the hasCapability method
-            const baseProto = Base.prototype;
-            if (baseProto && typeof baseProto.hasCapability === 'function') {
-                return baseProto.hasCapability.call(this, name);
-            }
-            return false;
-        }
-        // eslint-disable-next-line @typescript-eslint/no-explicit-any
-        constructor(...args) {
-            super(...args);
-            // Resolve R2 bucket from env if available
-            const env = this.env;
-            const r2BindingName = options.r2Binding ?? 'R2_BUCKET';
-            const r2 = env?.[r2BindingName];
-            // Get filesystem capability if available from $ context
-            const dollarContext = this.$;
-            const fs = dollarContext?.fs;
-            // Store resolved options
-            this[GIT_OPTIONS] = {
-                ...options,
-                r2,
-                fs,
-            };
-            // Extend $ context if contextMode is enabled
-            if (options.contextMode && dollarContext) {
-                const self = this;
-                const original$ = dollarContext;
-                this.$ = new Proxy(original$, {
-                    get(target, prop) {
-                        if (prop === 'git') {
-                            return self.git;
-                        }
-                        // Forward to original context
-                        const value = target[prop];
-                        if (typeof value === 'function') {
-                            return value.bind(target);
-                        }
-                        return value;
-                    },
-                });
-            }
-            // Auto-initialize if requested
-            if (options.autoInit) {
-                // Access git to trigger lazy initialization
-                void this.git.initialize();
-                this.gitInitialized = true;
-            }
-        }
-        /**
-         * Creates the GitModule instance with resolved options.
-         * @returns A new GitModule instance
-         */
-        createGitModule() {
-            const opts = this[GIT_OPTIONS];
-            return new GitModule({
-                repo: opts.repo,
-                branch: opts.branch,
-                path: opts.path,
-                r2: opts.r2,
-                fs: opts.fs,
-                objectPrefix: opts.objectPrefix,
-            });
-        }
-        /**
-         * Initialize the git module explicitly.
-         * This is useful when you need to ensure the module is ready
-         * before performing operations.
-         */
-        async initializeGit() {
-            if (!this.gitInitialized) {
-                await this.git.initialize();
-                this.gitInitialized = true;
-            }
-        }
-        /**
-         * Dispose the git module and clean up resources.
-         */
-        async disposeGit() {
-            if (this[GIT_MODULE_CACHE]) {
-                await this[GIT_MODULE_CACHE].dispose();
-                this[GIT_MODULE_CACHE] = undefined;
-                this.gitInitialized = false;
-            }
-        }
-    };
-}
-// ============================================================================
-// Type Guards
-// ============================================================================
-/**
- * Check if a value has git capability.
- *
- * @param value - Value to check
- * @returns True if value has the git property and it's a GitModule
- *
- * @example
- * ```typescript
- * if (hasGitCapability(instance)) {
- *   await instance.git.sync()
- * }
- * ```
- */
-export function hasGitCapability(value) {
-    return (typeof value === 'object' &&
-        value !== null &&
-        'git' in value &&
-        value.git instanceof GitModule);
-}
-// ============================================================================
-// Re-exports for Convenience
-// ============================================================================
-export { GitModule, };
-//# sourceMappingURL=withGit.js.map

package/dist/do/withGit.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"withGit.js","sourceRoot":"","sources":["../../src/do/withGit.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAkCG;AAEH,OAAO,EACL,SAAS,GAQV,MAAM,aAAa,CAAA;AAuFpB,+EAA+E;AAC/E,uCAAuC;AACvC,+EAA+E;AAE/E;;;GAGG;AACH,MAAM,gBAAgB,GAAG,MAAM,CAAC,gBAAgB,CAAC,CAAA;AAEjD;;GAEG;AACH,MAAM,WAAW,GAAG,MAAM,CAAC,YAAY,CAAC,CAAA;AAExC,+EAA+E;AAC/E,yBAAyB;AACzB,+EAA+E;AAE/E;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAiEG;AACH,MAAM,UAAU,OAAO,CACrB,IAAW,EACX,OAAuB;IAEvB,4BAA4B;IAC5B,IAAI,CAAC,OAAO,CAAC,IAAI,EAAE,CAAC;QAClB,MAAM,IAAI,KAAK,CAAC,kCAAkC,CAAC,CAAA;IACrD,CAAC;IAED,OAAO,MAAM,YAAa,SAAQ,IAAI;QACpC;;WAEG;QACH,MAAM,CAAC,YAAY,GAAG,CAAC,GAAG,CAAE,IAAgC,CAAC,YAAwB,IAAI,EAAE,CAAC,EAAE,KAAK,CAAC,CAAA;QAEpG;;WAEG;QACK,CAAC,gBAAgB,CAAC,CAAY;QAEtC;;WAEG;QACK,CAAC,WAAW,CAAC,CAAoB;QAEzC;;WAEG;QACK,cAAc,GAAG,KAAK,CAAA;QAE9B;;;;WAIG;QACH,IAAI,GAAG;YACL,IAAI,CAAC,IAAI,CAAC,gBAAgB,CAAC,EAAE,CAAC;gBAC5B,IAAI,CAAC,gBAAgB,CAAC,GAAG,IAAI,CAAC,eAAe,EAAE,CAAA;YACjD,CAAC;YACD,OAAO,IAAI,CAAC,gBAAgB,CAAC,CAAA;QAC/B,CAAC;QAED;;;;WAIG;QACH,aAAa,CAAC,IAAY;YACxB,IAAI,IAAI,KAAK,KAAK;gBAAE,OAAO,IAAI,CAAA;YAC/B,qDAAqD;YACrD,MAAM,SAAS,GAAG,IAAI,CAAC,SAAoC,CAAA;YAC3D,IAAI,SAAS,IAAI,OAAO,SAAS,CAAC,aAAa,KAAK,UAAU,EAAE,CAAC;gBAC/D,OAAQ,SAAS,CAAC,aAA2C,CAAC,IAAI,CAAC,IAAI,EAAE,IAAI,CAAC,CAAA;YAChF,CAAC;YACD,OAAO,KAAK,CAAA;QACd,CAAC;QAED,8DAA8D;QAC9D,YAAY,GAAG,IAAW;YACxB,KAAK,CAAC,GAAG,IAAI,CAAC,CAAA;YAEd,0CAA0C;YAC1C,MAAM,GAAG,GAAI,IAAgC,CAAC,GAA0C,CAAA;YACxF,MAAM,aAAa,GAAG,OAAO,CAAC,SAAS,IAAI,WAAW,CAAA;YACtD,MAAM,EAAE,GAAG,GAAG,EAAE,CAAC,aAAa,CAA6B,CAAA;YAE3D,wDAAwD;YACxD,MAAM,aAAa,GAAI,IAAgC,CAAC,CAAwC,CAAA;YAChG,MAAM,EAAE,GAAG,aAAa,EAAE,EAA8B,CAAA;YAExD,yBAAyB;YACzB,IAAI,CAAC,WAAW,CAAC,GAAG;gBAClB,GAAG,OAAO;gBACV,EAAE;gBACF,EAAE;aACH,CAAA;YAED,6CAA6C;YAC7C,IAAI,OAAO,CAAC,WAAW,IAAI,aAAa,EAAE,CAAC;gBACzC,MAAM,IAAI,GAAG,IAAI,CAAA;gBACjB,MAAM,SAAS,GAAG,aAAa,CAG9B;gBAAC,IAAgC,CAAC,CAAC,GAAG,IAAI,KAAK,CAAC,SAA2B,EAAE;oBAC5E,GAAG,CAAC,MAAM,EAAE,IAAqB;wBAC/B,IAAI,IAAI,KAAK,KAAK,EAAE,CAAC;4BACnB,OAAO,IAAI,CAAC,GAAG,CAAA;wBACjB,CAAC;wBACD,8BAA8B;wBAC9B,MAAM,KAAK,GAAI,MAAsD,CAAC,IAAI,CAAC,CAAA;wBAC3E,IAAI,OAAO,KAAK,KAAK,UAAU,EAAE,CAAC;4BAChC,OAAQ,KAAyC,CAAC,IAAI,CAAC,MAAM,CAAC,CAAA;wBAChE,CAAC;wBACD,OAAO,KAAK,CAAA;oBACd,CAAC;iBACF,CAAC,CAAA;YACJ,CAAC;YAED,+BAA+B;YAC/B,IAAI,OAAO,CAAC,QAAQ,EAAE,CAAC;gBACrB,4CAA4C;gBAC5C,KAAK,IAAI,CAAC,GAAG,CAAC,UAAU,EAAE,CAAA;gBAC1B,IAAI,CAAC,cAAc,GAAG,IAAI,CAAA;YAC5B,CAAC;QACH,CAAC;QAED;;;WAGG;QACK,eAAe;YACrB,MAAM,IAAI,GAAG,IAAI,CAAC,WAAW,CAAC,CAAA;YAE9B,OAAO,IAAI,SAAS,CAAC;gBACnB,IAAI,EAAE,IAAI,CAAC,IAAI;gBACf,MAAM,EAAE,IAAI,CAAC,MAAM;gBACnB,IAAI,EAAE,IAAI,CAAC,IAAI;gBACf,EAAE,EAAE,IAAI,CAAC,EAAE;gBACX,EAAE,EAAE,IAAI,CAAC,EAAE;gBACX,YAAY,EAAE,IAAI,CAAC,YAAY;aAChC,CAAC,CAAA;QACJ,CAAC;QAED;;;;WAIG;QACH,KAAK,CAAC,aAAa;YACjB,IAAI,CAAC,IAAI,CAAC,cAAc,EAAE,CAAC;gBACzB,MAAM,IAAI,CAAC,GAAG,CAAC,UAAU,EAAE,CAAA;gBAC3B,IAAI,CAAC,cAAc,GAAG,IAAI,CAAA;YAC5B,CAAC;QACH,CAAC;QAED;;WAEG;QACH,KAAK,CAAC,UAAU;YACd,IAAI,IAAI,CAAC,gBAAgB,CAAC,EAAE,CAAC;gBAC3B,MAAM,IAAI,CAAC,gBAAgB,CAAC,CAAC,OAAO,EAAE,CAAA;gBACtC,IAAI,CAAC,gBAAgB,CAAC,GAAG,SAAS,CAAA;gBAClC,IAAI,CAAC,cAAc,GAAG,KAAK,CAAA;YAC7B,CAAC;QACH,CAAC;KACwC,CAAA;AAC7C,CAAC;AAED,+EAA+E;AAC/E,cAAc;AACd,+EAA+E;AAE/E;;;;;;;;;;;;GAYG;AACH,MAAM,UAAU,gBAAgB,CAAC,KAAc;IAC7C,OAAO,CACL,OAAO,KAAK,KAAK,QAAQ;QACzB,KAAK,KAAK,IAAI;QACd,KAAK,IAAI,KAAK;QACd,KAAK,CAAC,GAAG,YAAY,SAAS,CAC/B,CAAA;AACH,CAAC;AAED,+EAA+E;AAC/E,6BAA6B;AAC7B,+EAA+E;AAE/E,OAAO,EACL,SAAS,GAQV,CAAA"}