devflare 0.0.0 → 1.0.0-next.0

package/dist/config/ref.d.ts

@@ -0,0 +1,160 @@
+import type { DevflareConfigInput } from './schema';
+import type { TypedConfig } from './define';
+/**
+ * Extract entrypoint type from a TypedConfig
+ * Falls back to string if no type parameter was provided
+ */
+type ExtractEntrypoints<TConfig> = TConfig extends TypedConfig<infer E> ? E : string;
+/**
+ * Extract the config type from a dynamic import function
+ * Handles both `{ default: Config }` and direct `Config` module shapes
+ */
+type ExtractConfig<TImport> = TImport extends () => Promise<infer TModule> ? TModule extends {
+    default: infer TConfig;
+} ? TConfig : TModule : DevflareConfigInput;
+/**
+ * Dynamic import function type for config modules
+ */
+type ConfigImport<T extends DevflareConfigInput = DevflareConfigInput> = () => Promise<{
+    default: T;
+} | T>;
+/**
+ * Worker binding reference - returned by ref().worker or ref().worker('entrypoint')
+ */
+export interface WorkerBinding {
+    /** Worker name (resolved lazily) */
+    readonly service: string;
+    /** Entrypoint class name (if specified) */
+    readonly entrypoint?: string;
+    /** @internal Reference for test context setup - contains import function and metadata */
+    readonly __ref?: RefResult;
+}
+/**
+ * Durable Object binding reference - returned by ref().DO_NAME
+ * Named differently from schema's DurableObjectBinding to avoid confusion
+ */
+export interface DOBindingRef {
+    /** DO class name */
+    readonly className: string;
+    /** Worker name that hosts this DO (for cross-worker access) */
+    readonly scriptName: string;
+    /** @internal Reference for test context setup */
+    readonly __ref?: RefResult;
+}
+/**
+ * Template literal type for matching uppercase DO binding names.
+ * This allows the index signature to return DOBindingRef for UPPER_CASE
+ * property access while keeping specific types for known properties.
+ */
+type UpperCaseName = `${Uppercase<string>}`;
+/**
+ * Accessor for worker bindings - can be accessed directly or called with entrypoint
+ * @template TEntrypoints - Union of valid entrypoint names from config
+ */
+export interface WorkerBindingAccessor<TEntrypoints extends string = string> extends WorkerBinding {
+    /**
+     * Get a service binding with a specific named entrypoint
+     * @param entrypoint - The entrypoint class name from ep.*.ts files
+     */
+    (entrypoint: TEntrypoints): WorkerBinding;
+}
+/**
+ * Result of ref() - a lazy proxy to the referenced config
+ * Supports dynamic DO binding access via property lookup (e.g., ref.COUNTER)
+ */
+export interface RefResult<TConfig extends DevflareConfigInput = DevflareConfigInput> {
+    /**
+     * The worker name from the config (or overridden)
+     * Accessing this triggers resolution if not already resolved.
+     */
+    readonly name: string;
+    /**
+     * Raw config object (for advanced usage)
+     * Accessing this triggers resolution if not already resolved.
+     */
+    readonly config: TConfig;
+    /**
+     * Path to the config file (for resolution)
+     */
+    readonly configPath: string;
+    /**
+     * Get a service binding to this worker's default export (WorkerEntrypoint)
+     * Call as function to specify entrypoint: .worker('AdminEntrypoint')
+     * Or access directly for default export: .worker
+     */
+    readonly worker: WorkerBindingAccessor<ExtractEntrypoints<TConfig>>;
+    /**
+     * @internal The import function for lazy resolution
+     */
+    readonly __import: ConfigImport<TConfig>;
+    /**
+     * @internal Optional name override
+     */
+    readonly __nameOverride?: string;
+    /**
+     * Resolve the reference and get the config
+     */
+    resolve(): Promise<{
+        name: string;
+        config: TConfig;
+        configPath: string;
+    }>;
+    /**
+     * Dynamic DO binding access: ref.COUNTER, ref.RATE_LIMITER, etc.
+     * Returns a DOBindingRef for cross-worker DO access.
+     * Uses template literal type to match UPPER_CASE binding names only.
+     */
+    readonly [K: UpperCaseName]: DOBindingRef;
+}
+/**
+ * Create a typed reference to another worker's config.
+ * Returns a lazy proxy - the import is resolved only when needed.
+ *
+ * @param nameOrImport - Worker name override, OR the import function
+ * @param maybeImport - Import function (if first arg is name)
+ * @returns RefResult proxy with lazy access to config metadata
+ *
+ * @example
+ * // Basic usage - name from config
+ * const mathWorker = ref(() => import('./math-worker/devflare.config'))
+ *
+ * export default defineConfig({
+ *   bindings: {
+ *     services: {
+ *       MATH: mathWorker.worker                    // Default export
+ *       // or: mathWorker.worker('MathService')    // Specific entrypoint
+ *     }
+ *   }
+ * })
+ *
+ * @example
+ * // With name override
+ * const mathWorker = ref('custom-math', () => import('./math-worker/devflare.config'))
+ */
+export declare function ref<TImport extends () => Promise<{
+    default: DevflareConfigInput;
+} | DevflareConfigInput>>(nameOrImport: string | TImport, maybeImport?: TImport): RefResult<ExtractConfig<TImport>>;
+/**
+ * @deprecated Use `ref()` instead and call `.resolve()` if you need immediate access.
+ */
+export declare function resolveRef<TConfig extends DevflareConfigInput>(configImport: ConfigImport<TConfig>, options?: {
+    workerName?: string;
+    entrypoint?: string;
+}): Promise<RefResult<TConfig>>;
+/**
+ * @deprecated Use `refResult.worker` or `refResult.worker('entrypoint')` instead.
+ */
+export declare function serviceBinding(refOrLegacy: RefResult | {
+    name: string;
+    entrypoint?: string;
+    config?: unknown;
+    configPath?: string;
+}, options?: {
+    entrypoint?: string;
+}): WorkerBinding;
+/**
+ * @deprecated Legacy type alias
+ */
+export type ServiceBindingWithRef = WorkerBinding;
+export {};
+//# sourceMappingURL=ref.d.ts.map

package/dist/config/ref.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"ref.d.ts","sourceRoot":"","sources":["../../src/config/ref.ts"],"names":[],"mappings":"AAiCA,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,UAAU,CAAA;AACnD,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,UAAU,CAAA;AAM3C;;;GAGG;AACH,KAAK,kBAAkB,CAAC,OAAO,IAAI,OAAO,SAAS,WAAW,CAAC,MAAM,CAAC,CAAC,GAAG,CAAC,GAAG,MAAM,CAAA;AAEpF;;;GAGG;AACH,KAAK,aAAa,CAAC,OAAO,IAAI,OAAO,SAAS,MAAM,OAAO,CAAC,MAAM,OAAO,CAAC,GACvE,OAAO,SAAS;IAAE,OAAO,EAAE,MAAM,OAAO,CAAA;CAAE,GACzC,OAAO,GACP,OAAO,GACR,mBAAmB,CAAA;AAEtB;;GAEG;AACH,KAAK,YAAY,CAAC,CAAC,SAAS,mBAAmB,GAAG,mBAAmB,IACpE,MAAM,OAAO,CAAC;IAAE,OAAO,EAAE,CAAC,CAAA;CAAE,GAAG,CAAC,CAAC,CAAA;AAElC;;GAEG;AACH,MAAM,WAAW,aAAa;IAC7B,oCAAoC;IACpC,QAAQ,CAAC,OAAO,EAAE,MAAM,CAAA;IACxB,2CAA2C;IAC3C,QAAQ,CAAC,UAAU,CAAC,EAAE,MAAM,CAAA;IAC5B,yFAAyF;IACzF,QAAQ,CAAC,KAAK,CAAC,EAAE,SAAS,CAAA;CAC1B;AAED;;;GAGG;AACH,MAAM,WAAW,YAAY;IAC5B,oBAAoB;IACpB,QAAQ,CAAC,SAAS,EAAE,MAAM,CAAA;IAC1B,+DAA+D;IAC/D,QAAQ,CAAC,UAAU,EAAE,MAAM,CAAA;IAC3B,iDAAiD;IACjD,QAAQ,CAAC,KAAK,CAAC,EAAE,SAAS,CAAA;CAC1B;AAED;;;;GAIG;AACH,KAAK,aAAa,GAAG,GAAG,SAAS,CAAC,MAAM,CAAC,EAAE,CAAA;AAE3C;;;GAGG;AACH,MAAM,WAAW,qBAAqB,CAAC,YAAY,SAAS,MAAM,GAAG,MAAM,CAAE,SAAQ,aAAa;IACjG;;;OAGG;IACH,CAAC,UAAU,EAAE,YAAY,GAAG,aAAa,CAAA;CACzC;AAED;;;GAGG;AACH,MAAM,WAAW,SAAS,CAAC,OAAO,SAAS,mBAAmB,GAAG,mBAAmB;IACnF;;;OAGG;IACH,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAA;IAErB;;;OAGG;IACH,QAAQ,CAAC,MAAM,EAAE,OAAO,CAAA;IAExB;;OAEG;IACH,QAAQ,CAAC,UAAU,EAAE,MAAM,CAAA;IAE3B;;;;OAIG;IACH,QAAQ,CAAC,MAAM,EAAE,qBAAqB,CAAC,kBAAkB,CAAC,OAAO,CAAC,CAAC,CAAA;IAEnE;;OAEG;IACH,QAAQ,CAAC,QAAQ,EAAE,YAAY,CAAC,OAAO,CAAC,CAAA;IAExC;;OAEG;IACH,QAAQ,CAAC,cAAc,CAAC,EAAE,MAAM,CAAA;IAEhC;;OAEG;IACH,OAAO,IAAI,OAAO,CAAC;QAAE,IAAI,EAAE,MAAM,CAAC;QAAC,MAAM,EAAE,OAAO,CAAC;QAAC,UAAU,EAAE,MAAM,CAAA;KAAE,CAAC,CAAA;IAEzE;;;;OAIG;IACH,QAAQ,EAAE,CAAC,EAAE,aAAa,GAAG,YAAY,CAAA;CACzC;AAmBD;;;;;;;;;;;;;;;;;;;;;;;;GAwBG;AACH,wBAAgB,GAAG,CAAC,OAAO,SAAS,MAAM,OAAO,CAAC;IAAE,OAAO,EAAE,mBAAmB,CAAA;CAAE,GAAG,mBAAmB,CAAC,EACxG,YAAY,EAAE,MAAM,GAAG,OAAO,EAC9B,WAAW,CAAC,EAAE,OAAO,GACnB,SAAS,CAAC,aAAa,CAAC,OAAO,CAAC,CAAC,CAAA;AAiLpC;;GAEG;AACH,wBAAsB,UAAU,CAAC,OAAO,SAAS,mBAAmB,EACnE,YAAY,EAAE,YAAY,CAAC,OAAO,CAAC,EACnC,OAAO,CAAC,EAAE;IAAE,UAAU,CAAC,EAAE,MAAM,CAAC;IAAC,UAAU,CAAC,EAAE,MAAM,CAAA;CAAE,GACpD,OAAO,CAAC,SAAS,CAAC,OAAO,CAAC,CAAC,CAO7B;AAED;;GAEG;AACH,wBAAgB,cAAc,CAC7B,WAAW,EAAE,SAAS,GAAG;IAAE,IAAI,EAAE,MAAM,CAAC;IAAC,UAAU,CAAC,EAAE,MAAM,CAAC;IAAC,MAAM,CAAC,EAAE,OAAO,CAAC;IAAC,UAAU,CAAC,EAAE,MAAM,CAAA;CAAE,EACrG,OAAO,CAAC,EAAE;IAAE,UAAU,CAAC,EAAE,MAAM,CAAA;CAAE,GAC/B,aAAa,CAcf;AAED;;GAEG;AACH,MAAM,MAAM,qBAAqB,GAAG,aAAa,CAAA"}