diorama-js 0.1.0

package/dist/vue.d.ts

@@ -0,0 +1,146 @@
+import * as vue from 'vue';
+
+/**
+ * Base error class for all Diorama errors.
+ * Every error has a `code` property for programmatic handling.
+ */
+declare class DioramaError extends Error {
+    readonly code: string;
+    constructor(code: string, message: string);
+}
+
+type ProjectType = 'static' | 'static-esm' | 'jsx' | 'typescript' | 'jsx-typescript' | 'vite';
+type CDNProviderName = 'esm.sh' | 'skypack' | 'unpkg';
+type CacheStrategy = 'normal' | 'aggressive';
+type LoadingStrategy = 'eager' | 'click' | 'viewport';
+/**
+ * Built-in decorative frame styles that wrap the rendered iframe.
+ *
+ * - `'none'`      — No frame (default).
+ * - `'standard'`  — Clean, minimal border with subtle shadow.
+ * - `'polaroid'`  — Polaroid-photo style with thick white bottom.
+ * - `'museum'`    — Ornate golden frame like a fine-art gallery.
+ * - `'terminal'`  — Dark terminal / code-editor chrome.
+ * - `'postcard'`  — Vintage postcard with stamp and postmark.
+ * - `'blueprint'` — Technical blueprint with grid overlay border.
+ * - `'browser'`   — Browser window chrome with address bar.
+ */
+type FrameStyle = 'none' | 'standard' | 'polaroid' | 'museum' | 'terminal' | 'postcard' | 'blueprint' | 'browser';
+interface DioramaOptions {
+    /** Enable localStorage caching. Default: `true`. */
+    cache?: boolean;
+    /** Cache time-to-live in seconds. Default: `3600` (1 hour). */
+    cacheTTL?: number;
+    /** Cache strategy. `'aggressive'` also caches the tree SHA. Default: `'normal'`. */
+    cacheStrategy?: CacheStrategy;
+    /** CDN used to resolve bare npm imports. Default: `'esm.sh'`. */
+    cdnProvider?: CDNProviderName;
+    /** Optional GitHub personal-access token (increases rate limit to 5 000/h). */
+    githubToken?: string;
+    /** URL to the esbuild-wasm binary. `'auto'` loads from esm.sh. */
+    esbuildWasmURL?: string | 'auto';
+    /** Maximum parallel file fetches. Default: `6`. */
+    maxConcurrentFetches?: number;
+    /** Total render timeout in milliseconds. Default: `30000`. */
+    timeout?: number;
+}
+interface RenderOptions {
+    /** Override the branch to render. */
+    branch?: string;
+    /** Render a subdirectory within the repo. */
+    subdirectory?: string;
+    /** When to create and populate the iframe. Default: `'eager'`. */
+    loading?: LoadingStrategy;
+    /** Image URL shown as a placeholder for `click` / `viewport` loading. */
+    placeholder?: string;
+    /** CSS height of the iframe. Default: `'500px'`. */
+    height?: string;
+    /** Decorative frame style wrapping the iframe. Default: `'none'`. */
+    frame?: FrameStyle;
+    /** Allow click-to-expand the preview to fill the viewport. Default: `false`. */
+    expand?: boolean;
+    /** Iframe sandbox flags. Default: `['allow-scripts']`. */
+    sandbox?: string[];
+    /** Override automatic project type detection. */
+    projectType?: ProjectType;
+    /** Override entry point detection. */
+    entryPoint?: string;
+    /** Glob patterns of files to include. */
+    include?: string[];
+    /** Glob patterns of files to exclude. */
+    exclude?: string[];
+    /** Called when rendering completes successfully. */
+    onLoad?: () => void;
+    /** Called when an error occurs at any pipeline stage. */
+    onError?: (error: DioramaError) => void;
+}
+interface DioramaInstance {
+    /** Re-fetch the project and re-render. */
+    reload(): Promise<void>;
+    /** Remove the iframe, revoke Blob URLs, clean up observers. */
+    destroy(): void;
+}
+
+declare class Diorama {
+    private options;
+    private cache;
+    constructor(options?: DioramaOptions);
+    /**
+     * Fetch, transform, and render a GitHub project inside a
+     * sandboxed iframe.
+     *
+     * @param container CSS selector or DOM element.
+     * @param repoURL   GitHub URL or `owner/repo` shorthand.
+     * @param options    Per-render options.
+     * @returns A handle for reloading or destroying the instance.
+     */
+    render(container: string | HTMLElement, repoURL: string, options?: RenderOptions): Promise<DioramaInstance>;
+    /**
+     * Pre-fetch a project (resolve + cache) without rendering.
+     */
+    prefetch(repoURL: string, options?: Pick<RenderOptions, 'branch' | 'subdirectory'>): Promise<void>;
+    /**
+     * Clear cached data.
+     * @param repoSlug Optional `owner/repo` to clear a specific entry.
+     */
+    clearCache(repoSlug?: string): void;
+    private fetchProject;
+}
+
+declare const DioramaPreview: vue.DefineComponent<{
+    repo: string;
+    loading: LoadingStrategy;
+    height: string;
+    frame: FrameStyle;
+    expand: boolean;
+    branch?: string | undefined;
+    subdirectory?: string | undefined;
+    placeholder?: string | undefined;
+    options?: DioramaOptions | undefined;
+}, () => vue.VNode<vue.RendererNode, vue.RendererElement, {
+    [key: string]: any;
+}>, {}, {}, {}, vue.ComponentOptionsMixin, vue.ComponentOptionsMixin, ("load" | "error")[], "load" | "error", vue.PublicProps, Readonly<{
+    repo: string;
+    loading: LoadingStrategy;
+    height: string;
+    frame: FrameStyle;
+    expand: boolean;
+    branch?: string | undefined;
+    subdirectory?: string | undefined;
+    placeholder?: string | undefined;
+    options?: DioramaOptions | undefined;
+}> & Readonly<{
+    onLoad?: ((...args: any[]) => any) | undefined;
+    onError?: ((...args: any[]) => any) | undefined;
+}>, {
+    branch: string;
+    subdirectory: string;
+    loading: LoadingStrategy;
+    placeholder: string;
+    height: string;
+    frame: FrameStyle;
+    expand: boolean;
+    options: DioramaOptions;
+}, {}, {}, {}, string, vue.ComponentProvideOptions, true, {}, any>;
+
+export { Diorama, DioramaPreview };