resourcexjs 2.4.1 → 2.5.1

package/dist/index.d.ts

@@ -1,21 +1,160 @@
-import { ResourceXError, LocatorError, ManifestError, ContentError } from "@resourcexjs/core";
-import { ResourceTypeError } from "@resourcexjs/type";
+import { BundledType, IsolatorType } from "@resourcexjs/type";
+/**
+* ResourceX configuration.
+*/
+interface ResourceXConfig {
+	/**
+	* Base path for local storage.
+	* Default: ~/.resourcex
+	*/
+	path?: string;
+	/**
+	* Central registry URL.
+	* Required for push/pull operations.
+	*/
+	registry?: string;
+	/**
+	* Additional custom resource types.
+	* Built-in types (text, json, binary) are always included.
+	*/
+	types?: BundledType[];
+	/**
+	* Isolator type for resolver execution.
+	* - "none": No isolation (default)
+	* - "srt": OS-level isolation
+	* - "cloudflare": Container isolation
+	* - "e2b": MicroVM isolation
+	*/
+	isolator?: IsolatorType;
+}
+/**
+* Resource - user-facing resource object.
+*
+* Three forms of resource reference:
+* - path: local directory (e.g., "./my-prompt")
+* - locator: identifier string (e.g., "hello.text@1.0.0")
+* - resource: this object with full metadata
+*/
+interface Resource {
+	/** Full locator string (e.g., "registry.example.com/hello.text@1.0.0") */
+	locator: string;
+	/** Resource registry (optional for local resources) */
+	registry?: string;
+	/** Resource path within registry (optional) */
+	path?: string;
+	/** Resource name */
+	name: string;
+	/** Resource type (e.g., "text", "json") */
+	type: string;
+	/** Tag (e.g., "1.0.0", "latest", "stable") */
+	tag: string;
+	/** File list in the resource archive */
+	files?: string[];
+}
+/**
+* Executable resource - result of use().
+*/
+interface Executable<T = unknown> {
+	/**
+	* Execute the resource resolver.
+	*/
+	execute: (args?: unknown) => Promise<T>;
+	/**
+	* JSON schema for arguments (if any).
+	*/
+	schema?: unknown;
+}
+/**
+* ResourceX interface - unified API for resource management.
+*
+* Users interact only with:
+* - path: local directory
+* - locator: resource identifier string (e.g., "hello.text@1.0.0")
+*/
+interface ResourceX {
+	/**
+	* Add resource from directory to local storage.
+	* @returns The added resource
+	*/
+	add(path: string): Promise<Resource>;
+	/**
+	* Link development directory (symlink for live editing).
+	*/
+	link(path: string): Promise<void>;
+	/**
+	* Unlink development directory.
+	*/
+	unlink(locator: string): Promise<void>;
+	/**
+	* Check if resource exists locally.
+	*/
+	has(locator: string): Promise<boolean>;
+	/**
+	* Get detailed resource information.
+	* @returns Resource with files list
+	*/
+	info(locator: string): Promise<Resource>;
+	/**
+	* Remove resource from local storage.
+	*/
+	remove(locator: string): Promise<void>;
+	/**
+	* Use resource and return executable.
+	* Checks: linked → local → cache → remote
+	*/
+	use<T = unknown>(locator: string): Promise<Executable<T>>;
+	/**
+	* Search local resources.
+	* @returns Array of locator strings
+	*/
+	search(query?: string): Promise<string[]>;
+	/**
+	* Push local resource to remote registry.
+	*/
+	push(locator: string): Promise<void>;
+	/**
+	* Pull resource from remote to local cache.
+	*/
+	pull(locator: string): Promise<void>;
+	/**
+	* Clear cached resources.
+	* @param registry - If provided, only clear resources from this registry
+	*/
+	clearCache(registry?: string): Promise<void>;
+	/**
+	* Add support for custom resource type.
+	*/
+	supportType(type: BundledType): void;
+}
+/**
+* Create a ResourceX client instance.
+*
+* @example
+* ```typescript
+* const rx = createResourceX({
+*   registry: "https://registry.mycompany.com"
+* });
+*
+* // Add from directory to local
+* await rx.add("./my-prompt");
+*
+* // Use and execute
+* const result = await rx.use("my-prompt.text@1.0.0");
+* await result.execute();
+*
+* // Push to remote registry
+* await rx.push("./my-prompt");
+*
+* // Pull from remote registry
+* await rx.pull("my-prompt.text@1.0.0");
+* ```
+*/
+declare function createResourceX(config?: ResourceXConfig): ResourceX;
+import { parse, format, manifest, archive, resource, extract, wrap } from "@resourcexjs/core";
+import { RXL, RXM, RXA, RXR, RXD } from "@resourcexjs/core";
 import { RegistryError } from "@resourcexjs/registry";
-import { RXL } from "@resourcexjs/core";
-import { parseRXL } from "@resourcexjs/core";
-import { RXM, ManifestData } from "@resourcexjs/core";
-import { createRXM } from "@resourcexjs/core";
-import { RXA, RXP, RXAInput, PathNode } from "@resourcexjs/core";
-import { createRXA } from "@resourcexjs/core";
-import { RXR } from "@resourcexjs/core";
-import { ResourceType, ResourceResolver, ResolvedResource, JSONSchema, BundledType, IsolatorType } from "@resourcexjs/type";
-import { TypeHandlerChain, bundleResourceType } from "@resourcexjs/type";
-import { textType, jsonType, binaryType, builtinTypes } from "@resourcexjs/type";
-import { ResourceLoader } from "@resourcexjs/loader";
-import { loadResource, FolderLoader } from "@resourcexjs/loader";
-import { LoadResourceConfig } from "@resourcexjs/loader";
-import { Registry, RegistryConfig, ClientRegistryConfig, ServerRegistryConfig, CreateRegistryConfig, DiscoveryResult, WellKnownResponse, Storage, SearchOptions } from "@resourcexjs/registry";
-import { DefaultRegistry, createRegistry, discoverRegistry, LocalStorage } from "@resourcexjs/registry";
-import { RegistryMiddleware, DomainValidation, withDomainValidation } from "@resourcexjs/registry";
+import { ResourceTypeError } from "@resourcexjs/type";
+import { BundledType as BundledType2, IsolatorType as IsolatorType2 } from "@resourcexjs/type";
+import { bundleResourceType } from "@resourcexjs/type";
 declare const VERSION: string;
-export { withDomainValidation, textType, parseRXL, loadResource, jsonType, discoverRegistry, createRegistry, createRXM, createRXA, bundleResourceType, builtinTypes, binaryType, WellKnownResponse, VERSION, TypeHandlerChain, Storage, ServerRegistryConfig, SearchOptions, ResourceXError, ResourceTypeError, ResourceType, ResourceResolver, ResourceLoader, ResolvedResource, RegistryMiddleware, RegistryError, RegistryConfig, Registry, RXR, RXP, RXM, RXL, RXAInput, RXA, PathNode, ManifestError, ManifestData, LocatorError, LocalStorage, LoadResourceConfig, JSONSchema, IsolatorType, FolderLoader, DomainValidation, DiscoveryResult, DefaultRegistry, CreateRegistryConfig, ContentError, ClientRegistryConfig, BundledType };
+export { wrap, resource, parse, manifest, format, extract, createResourceX, bundleResourceType, archive, VERSION, ResourceXConfig, ResourceX, ResourceTypeError, Resource, RegistryError, RXR, RXM, RXL, RXD, RXA, IsolatorType2 as IsolatorType, Executable, BundledType2 as BundledType };