@martini-film/cli 0.3.0 → 0.4.1

package/dist/generated/manifest.json

@@ -1,6 +1,6 @@
 {
     "version": 1,
-    "hash": "fcddfe8e2dd99bcc3e86d7fe454b8e5c4412e154fea9e4822492654df9c4d77b",
+    "hash": "5bb190df5eb33f307ac548a2fcce6be7fa87590bcd777893a93c541963c6fdfa",
     "generatedAt": "1970-01-01T00:00:00.000Z",
     "tools": [
         {
@@ -2155,7 +2155,7 @@
                                 },
                                 "agentId": {
                                     "default": "opus-5.5",
-                                    "description": "Executor chat model — same catalog as the in-app chat: 'opus-5.5' (Claude Opus 5.5, default), 'chat-gpt' (GPT-6 Sol — cheaper, for routine steps), 'chat-sonnet' (Claude Sonnet), 'gpt-6-astra' (GPT-6 Astra) and 'fable-5.1' (Claude Fable 5.1) — the premium tier, 'chat-grok' (Grok 4.7), 'chat-minimax' (MiniMax M3 — the economical choice for bulk mechanical steps). Drives the plan pass, unit sessions, and judge — not the media model, which the brief's @Model tags or the plan decide.",
+                                    "description": "Executor chat model — same catalog as the in-app chat: 'opus-5.5' (Claude Opus 5.5, default), 'chat-gpt' (GPT-6.1 Sol — cheaper, for routine steps), 'chat-sonnet' (Claude Sonnet 5.5), 'gpt-6-astra' (GPT-6 Astra) and 'fable-5.1' (Claude Fable 5.1) — the premium tier, 'chat-grok' (Grok 4.7), 'chat-minimax' (MiniMax M3 — the economical choice for bulk mechanical steps). Drives the plan pass, unit sessions, and judge — not the media model, which the brief's @Model tags or the plan decide.",
                                     "type": "string",
                                     "minLength": 1,
                                     "maxLength": 80
@@ -2736,7 +2736,7 @@
                         "type": "string"
                     },
                     "startFrameUrl": {
-                        "description": "Start-frame image URL (https workspace asset URL) to stage on the draft for image-to-video.",
+                        "description": "Start-frame image URL (https workspace asset URL, or its asset id) to stage on the draft for image-to-video.",
                         "type": "string",
                         "maxLength": 2048
                     },
@@ -2784,7 +2784,7 @@
                         }
                     },
                     "referenceImages": {
-                        "description": "Ordered reference image URLs stored on the draft and shown in its Reference Images panel. Bind them in draftPrompt as @Image1, @Image2, … https URLs with a public hostname only — Martini asset URLs (from get_asset / get_board_assets) live-bind to their source node; data:/blob:/http:/localhost/private-IP URLs are rejected.",
+                        "description": "Ordered reference image URLs stored on the draft and shown in its Reference Images panel. Bind them in draftPrompt as @Image1, @Image2, … https URLs with a public hostname only — Martini asset URLs (from get_asset / get_board_assets) live-bind to their source node, as does an asset id; data:/blob:/http:/localhost/private-IP URLs are rejected.",
                         "maxItems": 20,
                         "type": "array",
                         "items": {
@@ -3622,11 +3622,11 @@
                         "exclusiveMinimum": 0
                     },
                     "imageUrl": {
-                        "description": "Start frame image URL (for image-to-video)",
+                        "description": "Start frame image URL or asset id (for image-to-video)",
                         "type": "string"
                     },
                     "endFrameUrl": {
-                        "description": "End frame image URL",
+                        "description": "End frame image URL or asset id",
                         "type": "string"
                     },
                     "middleFrameUrl": {
@@ -3665,7 +3665,7 @@
                         }
                     },
                     "referenceImages": {
-                        "description": "Ordered reference image URLs for style consistency. Must be Martini CDN URLs from uploaded assets or get_asset. Bind them in the prompt as @Image1, @Image2, …; bare names do not bind media. One contact sheet is one reference. For recurring characters, props, or locations, prefer Library elements instead.",
+                        "description": "Ordered reference image URLs for style consistency. Must be Martini CDN URLs from uploaded assets or get_asset, or their asset ids. Bind them in the prompt as @Image1, @Image2, …; bare names do not bind media. One contact sheet is one reference. For recurring characters, props, or locations, prefer Library elements instead.",
                         "type": "array",
                         "items": {
                             "type": "string"
@@ -4449,7 +4449,7 @@
                                     }
                                 },
                                 "referenceImages": {
-                                    "description": "Ordered reference image URLs stored on the draft and shown in its Reference Images panel. Bind them in draftPrompt as @Image1, @Image2, … https URLs with a public hostname only — Martini asset URLs (from get_asset / get_board_assets) live-bind to their source node; data:/blob:/http:/localhost/private-IP URLs are rejected.",
+                                    "description": "Ordered reference image URLs stored on the draft and shown in its Reference Images panel. Bind them in draftPrompt as @Image1, @Image2, … https URLs with a public hostname only — Martini asset URLs (from get_asset / get_board_assets) live-bind to their source node, as does an asset id; data:/blob:/http:/localhost/private-IP URLs are rejected.",
                                     "maxItems": 20,
                                     "type": "array",
                                     "items": {
@@ -4794,7 +4794,7 @@
                                     }
                                 },
                                 "startFrameUrl": {
-                                    "description": "Start-frame image URL (https workspace asset URL) to stage on the draft for image-to-video.",
+                                    "description": "Start-frame image URL (https workspace asset URL, or its asset id) to stage on the draft for image-to-video.",
                                     "type": "string",
                                     "maxLength": 2048
                                 },
@@ -5428,11 +5428,11 @@
                                     "exclusiveMinimum": 0
                                 },
                                 "imageUrl": {
-                                    "description": "Start frame image URL (for image-to-video)",
+                                    "description": "Start frame image URL or asset id (for image-to-video)",
                                     "type": "string"
                                 },
                                 "endFrameUrl": {
-                                    "description": "End frame image URL",
+                                    "description": "End frame image URL or asset id",
                                     "type": "string"
                                 },
                                 "middleFrameUrl": {
@@ -5471,7 +5471,7 @@
                                     }
                                 },
                                 "referenceImages": {
-                                    "description": "Ordered reference image URLs for style consistency. Must be Martini CDN URLs from uploaded assets or get_asset. Bind them in the prompt as @Image1, @Image2, …; bare names do not bind media. One contact sheet is one reference. For recurring characters, props, or locations, prefer Library elements instead.",
+                                    "description": "Ordered reference image URLs for style consistency. Must be Martini CDN URLs from uploaded assets or get_asset, or their asset ids. Bind them in the prompt as @Image1, @Image2, …; bare names do not bind media. One contact sheet is one reference. For recurring characters, props, or locations, prefer Library elements instead.",
                                     "type": "array",
                                     "items": {
                                         "type": "string"
@@ -6176,7 +6176,7 @@
         {
             "name": "create_project",
             "title": "Create Project",
-            "description": "Create a new Martini project for the authenticated user. Optionally pass a teamId to create a private team project. After creating an empty project, use create_canvas before adding board content.",
+            "description": "Create a new Martini project for the authenticated user. Optionally pass a teamId to create a private team project. A personal project starts with link sharing on (anyone with its link can edit; the result reports it as visibility, visibilityLabel, and accessLabel) unless visibility says otherwise: pass visibility \"private\" for confidential material (it needs a Pro or Team plan), and say so when you leave the default. After creating an empty project, use create_canvas before adding board content.",
             "inputSchema": {
                 "type": "object",
                 "properties": {
@@ -6190,6 +6190,15 @@
                         "type": "string",
                         "format": "uuid",
                         "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
+                    },
+                    "visibility": {
+                        "description": "Sharing for a personal project: private (members only; needs a Pro or Team plan), link_view (anyone with the link can view), or link_edit (anyone with the link can edit; the default). A team project is always private.",
+                        "type": "string",
+                        "enum": [
+                            "private",
+                            "link_view",
+                            "link_edit"
+                        ]
                     }
                 },
                 "$schema": "http://json-schema.org/draft-07/schema#",
@@ -7424,11 +7433,11 @@
                         "exclusiveMinimum": 0
                     },
                     "imageUrl": {
-                        "description": "Start frame image URL (for image-to-video)",
+                        "description": "Start frame image URL or asset id (for image-to-video)",
                         "type": "string"
                     },
                     "endFrameUrl": {
-                        "description": "End frame image URL",
+                        "description": "End frame image URL or asset id",
                         "type": "string"
                     },
                     "middleFrameUrl": {
@@ -7441,7 +7450,7 @@
                         "exclusiveMinimum": 0
                     },
                     "referenceImages": {
-                        "description": "Ordered reference image URLs for style consistency. Bind them in the prompt as @Image1, @Image2, …; bare names do not bind media. One contact sheet is one reference. Use elements instead for character/subject references.",
+                        "description": "Ordered reference image URLs (or asset ids) for style consistency. Bind them in the prompt as @Image1, @Image2, …; bare names do not bind media. One contact sheet is one reference. Use elements instead for character/subject references.",
                         "type": "array",
                         "items": {
                             "type": "string"
@@ -7998,7 +8007,7 @@
         {
             "name": "generate_nodes",
             "title": "Generate Draft Nodes (Batch)",
-            "description": "Generate existing draft nodes from their staged settings (model, prompt, frames, references). First call without batchApproval: Martini returns a server-computed olive estimate and generates nothing. Present the plan and total to the user, then re-call with batchApproval and the returned planHash. Submission has per-node error isolation; poll with get_jobs. Board variables expand at submit time. FLUX.3 drafts staged with flux3RenderQuality \"draft\" are estimated and billed at draft rates, and auto-duration drafts are quoted at their full hold with the unused seconds refunded on completion.",
+            "description": "Generate existing draft nodes from their staged settings (model, prompt, frames, references). First call without batchApproval: Martini returns a server-computed olive estimate and generates nothing. Present the plan and total to the user, then re-call with batchApproval and the returned planHash. Submission has per-node error isolation; then wait with wait_for_jobs, not a get_jobs poll. Board variables expand at submit time. FLUX.3 drafts staged with flux3RenderQuality \"draft\" are estimated and billed at draft rates, and auto-duration drafts are quoted at their full hold with the unused seconds refunded on completion.",
             "inputSchema": {
                 "type": "object",
                 "properties": {
@@ -8225,6 +8234,14 @@
                             "type": "object",
                             "properties": {
                                 "nodeId": {
+                                    "type": "string",
+                                    "description": "Draft node id (asset-<uuid>)."
+                                },
+                                "assetId": {
+                                    "description": "The same node as a bare asset id: what get_asset, the wait, and the review take.",
+                                    "type": "string"
+                                },
+                                "displayName": {
                                     "type": "string"
                                 },
                                 "modelId": {
@@ -14548,6 +14565,10 @@
                             "refundedAmount": {
                                 "type": "number"
                             },
+                            "chargedOlives": {
+                                "description": "Olives this job cost: the hold less any refund.",
+                                "type": "number"
+                            },
                             "imageBilling": {
                                 "type": "object",
                                 "properties": {
@@ -14740,6 +14761,10 @@
                                 "refundedAmount": {
                                     "type": "number"
                                 },
+                                "chargedOlives": {
+                                    "description": "Olives this job cost: the hold less any refund.",
+                                    "type": "number"
+                                },
                                 "imageBilling": {
                                     "type": "object",
                                     "properties": {
@@ -14888,7 +14913,7 @@
         {
             "name": "get_models",
             "title": "Get Models",
-            "description": "List models (compact, paged), resolve a model/provider name, or inspect one exact model in full. query resolves names like \"GPT image\" or \"Kling\"; modelId inspects one exact ID (guidance and inputs live there); omit both to list.",
+            "description": "List models (compact, paged), resolve a model/provider name, or inspect one exact model in full. query resolves names like \"GPT image\" or \"Kling\"; modelId inspects one exact ID (guidance and inputs live there); omit both to list. Costs are in olives.",
             "inputSchema": {
                 "type": "object",
                 "properties": {
@@ -15028,7 +15053,7 @@
                                     }
                                 },
                                 "mcpInputBindings": {
-                                    "description": "Per input: whether it is settable over MCP and under which tool parameter names.",
+                                    "description": "Per input: whether it is settable, and its argument names (draftParameterNames: on the draft tools).",
                                     "type": "object",
                                     "propertyNames": {
                                         "type": "string"
@@ -15043,6 +15068,14 @@
                                                 "type": "boolean"
                                             },
                                             "parameterNames": {
+                                                "description": "The input's argument names on generate.",
+                                                "type": "array",
+                                                "items": {
+                                                    "type": "string"
+                                                }
+                                            },
+                                            "draftParameterNames": {
+                                                "description": "Its names on the draft tools, where they differ (durationSeconds).",
                                                 "type": "array",
                                                 "items": {
                                                     "type": "string"
@@ -15175,7 +15208,7 @@
                                 }
                             },
                             "mcpInputBindings": {
-                                "description": "Per input: whether it is settable over MCP and under which tool parameter names.",
+                                "description": "Per input: whether it is settable, and its argument names (draftParameterNames: on the draft tools).",
                                 "type": "object",
                                 "propertyNames": {
                                     "type": "string"
@@ -15190,6 +15223,14 @@
                                             "type": "boolean"
                                         },
                                         "parameterNames": {
+                                            "description": "The input's argument names on generate.",
+                                            "type": "array",
+                                            "items": {
+                                                "type": "string"
+                                            }
+                                        },
+                                        "draftParameterNames": {
+                                            "description": "Its names on the draft tools, where they differ (durationSeconds).",
                                             "type": "array",
                                             "items": {
                                                 "type": "string"
@@ -15283,7 +15324,7 @@
                                         }
                                     },
                                     "mcpInputBindings": {
-                                        "description": "Per input: whether it is settable over MCP and under which tool parameter names.",
+                                        "description": "Per input: whether it is settable, and its argument names (draftParameterNames: on the draft tools).",
                                         "type": "object",
                                         "propertyNames": {
                                             "type": "string"
@@ -15298,6 +15339,14 @@
                                                     "type": "boolean"
                                                 },
                                                 "parameterNames": {
+                                                    "description": "The input's argument names on generate.",
+                                                    "type": "array",
+                                                    "items": {
+                                                        "type": "string"
+                                                    }
+                                                },
+                                                "draftParameterNames": {
+                                                    "description": "Its names on the draft tools, where they differ (durationSeconds).",
                                                     "type": "array",
                                                     "items": {
                                                         "type": "string"
@@ -20259,7 +20308,7 @@
         {
             "name": "render_timeline_frame",
             "title": "Render Timeline Frame",
-            "description": "See the COMPOSED timeline as it plays: renders the top visible clip at a given time (or a strip of frames across a range) into a JPEG image block, so you can QA an edit you just made — clip order, trims, ordering, nested sequences, and track priority. This is editor-preview compositing (the winning clip at each instant); it does NOT bake in transitions, opacity, or filters — use the full render/export for final output. Gaps render as black frames. Read-only; reads from R2 on every call.",
+            "description": "See the COMPOSED timeline as it plays: renders the top visible clip at a given time (or a strip of frames across a range) into a JPEG image block, so you can QA an edit you just made — clip order, trims, ordering, nested sequences, and track priority. This is editor-preview compositing (the winning clip at each instant); it does NOT bake in transitions, opacity, or filters — use the full render/export for final output. It is a small labelled preview (extract_video_frame gives a full-size still). Gaps render as black frames. Read-only; reads from R2 on every call.",
             "inputSchema": {
                 "type": "object",
                 "properties": {
@@ -22059,7 +22108,7 @@
                         "type": "string"
                     },
                     "startFrameUrl": {
-                        "description": "Start-frame image URL (https workspace asset URL) to stage on the draft for image-to-video. Pass null to clear the staged frame.",
+                        "description": "Start-frame image URL (https workspace asset URL, or its asset id) to stage on the draft for image-to-video. Pass null to clear the staged frame.",
                         "anyOf": [
                             {
                                 "type": "string",
@@ -22109,7 +22158,7 @@
                         }
                     },
                     "referenceImages": {
-                        "description": "Ordered reference image URLs stored on the draft and shown in its Reference Images panel. Bind them in draftPrompt as @Image1, @Image2, … https URLs with a public hostname only — Martini asset URLs (from get_asset / get_board_assets) live-bind to their source node; data:/blob:/http:/localhost/private-IP URLs are rejected.",
+                        "description": "Ordered reference image URLs stored on the draft and shown in its Reference Images panel. Bind them in draftPrompt as @Image1, @Image2, … https URLs with a public hostname only — Martini asset URLs (from get_asset / get_board_assets) live-bind to their source node, as does an asset id; data:/blob:/http:/localhost/private-IP URLs are rejected.",
                         "maxItems": 20,
                         "type": "array",
                         "items": {

package/dist/guideCache.js

@@ -0,0 +1,204 @@
+import { readFileSync, rmSync } from 'node:fs';
+import { CLI_VERSION, MANIFEST_FETCH_TIMEOUT_MS, userAgent } from './api.js';
+import { isRunKey } from './config.js';
+import guideJson from './generated/guide.json' with { type: 'json' };
+import { credentialCachePath, MANIFEST_REFRESH_ENV, refreshDisabled, writePrivateFileAtomic, } from './manifestCache.js';
+export const GUIDE_TRANSPORT = 'cli';
+export const GUIDE_HASH_HEADER = 'x-martini-guide-hash';
+export function loadBakedGuide() {
+    return guideJson;
+}
+export function guideCachePath(env, apiUrl, apiKey) {
+    return credentialCachePath('guide', env, apiUrl, apiKey);
+}
+export function openGuide(options) {
+    const { baked, apiUrl, apiKey, env, warn } = options;
+    const now = options.now ?? Date.now;
+    const runKey = isRunKey(apiKey);
+    const cachePath = apiKey && !runKey ? guideCachePath(env, apiUrl, apiKey) : null;
+    let cached = cachePath ? readCache(cachePath, warn) : null;
+    return {
+        get state() {
+            if (cached)
+                return { source: 'cache', guide: cached.guide, fetchedAt: cached.fetchedAt, cachePath };
+            return { source: 'baked', guide: baked, cachePath };
+        },
+        async refresh({ force = false } = {}) {
+            if (!apiKey || runKey)
+                return 'skipped';
+            if (refreshDisabled(env)) {
+                if (force) {
+                    warn('GUIDE_REFRESH_DISABLED', `${MANIFEST_REFRESH_ENV}=${env[MANIFEST_REFRESH_ENV]} turns refreshes off, so the guide was not fetched. Unset it to refresh.`);
+                }
+                return 'skipped';
+            }
+            const inUse = cached ? `the cached guide from ${cached.fetchedAt}` : "this build's guide";
+            let answer;
+            try {
+                answer = await options.fetchGuide(force || !cached ? undefined : cached.guide.hash);
+            }
+            catch (error) {
+                warn('GUIDE_REFRESH_FAILED', `Could not refresh the guide from ${apiUrl} (${messageOf(error)}); printing ${inUse}.`);
+                return 'failed';
+            }
+            if (answer.notModified)
+                return 'unchanged';
+            const guide = usableGuide(answer.body, answer.etag);
+            if (!guide) {
+                warn('GUIDE_REFRESH_FAILED', `The server answered GET /v1/guide without a usable guide; printing ${inUse}.`);
+                return 'failed';
+            }
+            cached = { guide, fetchedAt: new Date(now()).toISOString() };
+            if (cachePath) {
+                try {
+                    writePrivateFileAtomic(cachePath, JSON.stringify({ ...cached.guide, fetchedAt: cached.fetchedAt }));
+                }
+                catch (error) {
+                    warn('GUIDE_CACHE_WRITE_FAILED', `Could not save the guide to ${cachePath} (${messageOf(error)}); only this command uses it.`);
+                }
+            }
+            return 'updated';
+        },
+    };
+}
+export function guideFetcher(options) {
+    return async (ifNoneMatch) => {
+        const headers = {
+            'User-Agent': userAgent(options.env),
+            'X-Martini-Client': `martini-cli/${CLI_VERSION}`,
+            ...(options.apiKey ? { Authorization: `Bearer ${options.apiKey}` } : {}),
+            ...(ifNoneMatch ? { 'If-None-Match': `"${ifNoneMatch}"` } : {}),
+        };
+        const response = await options.fetch(`${options.apiUrl}/v1/guide?transport=${GUIDE_TRANSPORT}`, {
+            method: 'GET',
+            headers,
+            signal: AbortSignal.timeout(MANIFEST_FETCH_TIMEOUT_MS),
+        });
+        if (response.status === 304)
+            return { notModified: true };
+        if (!response.ok) {
+            let detail = '';
+            try {
+                const body = (await response.json());
+                if (typeof body.error === 'string')
+                    detail = `: ${body.error}`;
+            }
+            catch {
+            }
+            throw new Error(`GET /v1/guide answered ${response.status}${detail}`);
+        }
+        const etag = response.headers
+            .get('etag')
+            ?.replace(/^W\//, '')
+            .replace(/^"(.*)"$/, '$1');
+        return { notModified: false, body: await response.json(), etag: etag ?? null };
+    };
+}
+function isRecord(value) {
+    return value !== null && typeof value === 'object' && !Array.isArray(value);
+}
+function isTopic(value) {
+    return (isRecord(value) &&
+        typeof value.id === 'string' &&
+        value.id.length > 0 &&
+        typeof value.title === 'string' &&
+        Array.isArray(value.lines) &&
+        value.lines.every(line => typeof line === 'string'));
+}
+export function usableGuide(body, etag) {
+    if (!isRecord(body) || body.version !== 1 || body.transport !== GUIDE_TRANSPORT)
+        return null;
+    const hash = typeof body.hash === 'string' && body.hash ? body.hash : etag;
+    if (!hash || !Array.isArray(body.topics) || body.topics.length === 0 || !body.topics.every(isTopic))
+        return null;
+    return {
+        version: 1,
+        transport: GUIDE_TRANSPORT,
+        hash,
+        generatedAt: typeof body.generatedAt === 'string' ? body.generatedAt : '',
+        topics: body.topics.map(({ id, title, lines }) => ({ id, title, lines: [...lines] })),
+    };
+}
+export function guideHashNotice(options) {
+    const { apiKey } = options;
+    if (options.quiet)
+        return () => undefined;
+    const keyed = apiKey && !isRunKey(apiKey) ? apiKey : null;
+    const cachePath = keyed ? guideCachePath(options.env, options.apiUrl, keyed) : null;
+    const noticePath = keyed ? credentialCachePath('guide-notice', options.env, options.apiUrl, keyed) : null;
+    let localHash;
+    let said = false;
+    return serverHash => {
+        if (!cachePath || !noticePath || said || !serverHash)
+            return;
+        localHash ??= peekGuideHash(cachePath) ?? options.baked.hash;
+        if (serverHash === localHash)
+            return;
+        const notice = readNotice(noticePath);
+        if (notice?.serverHash === serverHash && notice.localHash === localHash)
+            return;
+        said = true;
+        options.warn('GUIDE_CHANGED', `The operator guide changed since the copy this CLI has (${localHash.slice(0, 12)} → ${serverHash.slice(0, 12)}). Run martini guide (or martini guide <topic>) before relying on it.`);
+        try {
+            writePrivateFileAtomic(noticePath, JSON.stringify({ localHash, serverHash }));
+        }
+        catch {
+        }
+    };
+}
+function peekGuideHash(path) {
+    try {
+        const entry = JSON.parse(readFileSync(path, 'utf8'));
+        return usableGuide(entry, null)?.hash ?? null;
+    }
+    catch {
+        return null;
+    }
+}
+function readNotice(path) {
+    try {
+        const entry = JSON.parse(readFileSync(path, 'utf8'));
+        if (!entry || typeof entry !== 'object')
+            return null;
+        const { localHash, serverHash } = entry;
+        return typeof localHash === 'string' && typeof serverHash === 'string' ? { localHash, serverHash } : null;
+    }
+    catch {
+        return null;
+    }
+}
+function messageOf(error) {
+    return error instanceof Error ? error.message : String(error);
+}
+function readCache(path, warn) {
+    let text;
+    try {
+        text = readFileSync(path, 'utf8');
+    }
+    catch (error) {
+        const code = error.code;
+        if (code === 'ENOENT' || code === 'ENOTDIR')
+            return null;
+        warn('GUIDE_CACHE_IGNORED', `Could not read the cached guide ${path} (${messageOf(error)}); printing this build's.`);
+        return null;
+    }
+    let entry;
+    try {
+        entry = JSON.parse(text);
+    }
+    catch {
+        entry = null;
+    }
+    const guide = usableGuide(entry, null);
+    if (!guide || !isRecord(entry) || typeof entry.fetchedAt !== 'string') {
+        try {
+            rmSync(path, { force: true });
+        }
+        catch {
+        }
+        warn('GUIDE_CACHE_IGNORED', `The cached guide ${path} was not valid and has been removed.`);
+        return null;
+    }
+    return { guide, fetchedAt: entry.fetchedAt };
+}
+//# sourceMappingURL=guideCache.js.map

package/dist/guideCache.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"guideCache.js","sourceRoot":"","sources":["../src/guideCache.ts"],"names":[],"mappings":"AAaA,OAAO,EAAE,YAAY,EAAE,MAAM,EAAE,MAAM,SAAS,CAAA;AAE9C,OAAO,EAAE,WAAW,EAAE,yBAAyB,EAAE,SAAS,EAAE,MAAM,UAAU,CAAA;AAC5E,OAAO,EAAE,QAAQ,EAAE,MAAM,aAAa,CAAA;AACtC,OAAO,SAAS,MAAM,wBAAwB,CAAC,OAAO,IAAI,EAAE,MAAM,EAAE,CAAA;AACpE,OAAO,EACL,mBAAmB,EACnB,oBAAoB,EACpB,eAAe,EACf,sBAAsB,GAEvB,MAAM,oBAAoB,CAAA;AAG3B,MAAM,CAAC,MAAM,eAAe,GAAG,KAAK,CAAA;AAGpC,MAAM,CAAC,MAAM,iBAAiB,GAAG,sBAAsB,CAAA;AA4DvD,MAAM,UAAU,cAAc;IAC5B,OAAO,SAAqC,CAAA;AAC9C,CAAC;AAGD,MAAM,UAAU,cAAc,CAAC,GAAsB,EAAE,MAAc,EAAE,MAAc;IACnF,OAAO,mBAAmB,CAAC,OAAO,EAAE,GAAG,EAAE,MAAM,EAAE,MAAM,CAAC,CAAA;AAC1D,CAAC;AAED,MAAM,UAAU,SAAS,CAAC,OAA4B;IACpD,MAAM,EAAE,KAAK,EAAE,MAAM,EAAE,MAAM,EAAE,GAAG,EAAE,IAAI,EAAE,GAAG,OAAO,CAAA;IACpD,MAAM,GAAG,GAAG,OAAO,CAAC,GAAG,IAAI,IAAI,CAAC,GAAG,CAAA;IACnC,MAAM,MAAM,GAAG,QAAQ,CAAC,MAAM,CAAC,CAAA;IAC/B,MAAM,SAAS,GAAG,MAAM,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC,cAAc,CAAC,GAAG,EAAE,MAAM,EAAE,MAAM,CAAC,CAAC,CAAC,CAAC,IAAI,CAAA;IAChF,IAAI,MAAM,GAAG,SAAS,CAAC,CAAC,CAAC,SAAS,CAAC,SAAS,EAAE,IAAI,CAAC,CAAC,CAAC,CAAC,IAAI,CAAA;IAE1D,OAAO;QACL,IAAI,KAAK;YACP,IAAI,MAAM;gBAAE,OAAO,EAAE,MAAM,EAAE,OAAO,EAAE,KAAK,EAAE,MAAM,CAAC,KAAK,EAAE,SAAS,EAAE,MAAM,CAAC,SAAS,EAAE,SAAS,EAAE,CAAA;YACnG,OAAO,EAAE,MAAM,EAAE,OAAO,EAAE,KAAK,EAAE,KAAK,EAAE,SAAS,EAAE,CAAA;QACrD,CAAC;QAED,KAAK,CAAC,OAAO,CAAC,EAAE,KAAK,GAAG,KAAK,EAAE,GAAG,EAAE;YAClC,IAAI,CAAC,MAAM,IAAI,MAAM;gBAAE,OAAO,SAAS,CAAA;YACvC,IAAI,eAAe,CAAC,GAAG,CAAC,EAAE,CAAC;gBACzB,IAAI,KAAK,EAAE,CAAC;oBACV,IAAI,CACF,wBAAwB,EACxB,GAAG,oBAAoB,IAAI,GAAG,CAAC,oBAAoB,CAAC,0EAA0E,CAC/H,CAAA;gBACH,CAAC;gBACD,OAAO,SAAS,CAAA;YAClB,CAAC;YACD,MAAM,KAAK,GAAG,MAAM,CAAC,CAAC,CAAC,yBAAyB,MAAM,CAAC,SAAS,EAAE,CAAC,CAAC,CAAC,oBAAoB,CAAA;YACzF,IAAI,MAAkB,CAAA;YACtB,IAAI,CAAC;gBACH,MAAM,GAAG,MAAM,OAAO,CAAC,UAAU,CAAC,KAAK,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,MAAM,CAAC,KAAK,CAAC,IAAI,CAAC,CAAA;YACrF,CAAC;YAAC,OAAO,KAAK,EAAE,CAAC;gBACf,IAAI,CACF,sBAAsB,EACtB,oCAAoC,MAAM,KAAK,SAAS,CAAC,KAAK,CAAC,eAAe,KAAK,GAAG,CACvF,CAAA;gBACD,OAAO,QAAQ,CAAA;YACjB,CAAC;YACD,IAAI,MAAM,CAAC,WAAW;gBAAE,OAAO,WAAW,CAAA;YAC1C,MAAM,KAAK,GAAG,WAAW,CAAC,MAAM,CAAC,IAAI,EAAE,MAAM,CAAC,IAAI,CAAC,CAAA;YACnD,IAAI,CAAC,KAAK,EAAE,CAAC;gBACX,IAAI,CAAC,sBAAsB,EAAE,sEAAsE,KAAK,GAAG,CAAC,CAAA;gBAC5G,OAAO,QAAQ,CAAA;YACjB,CAAC;YACD,MAAM,GAAG,EAAE,KAAK,EAAE,SAAS,EAAE,IAAI,IAAI,CAAC,GAAG,EAAE,CAAC,CAAC,WAAW,EAAE,EAAE,CAAA;YAC5D,IAAI,SAAS,EAAE,CAAC;gBACd,IAAI,CAAC;oBACH,sBAAsB,CAAC,SAAS,EAAE,IAAI,CAAC,SAAS,CAAC,EAAE,GAAG,MAAM,CAAC,KAAK,EAAE,SAAS,EAAE,MAAM,CAAC,SAAS,EAAE,CAAC,CAAC,CAAA;gBACrG,CAAC;gBAAC,OAAO,KAAK,EAAE,CAAC;oBACf,IAAI,CACF,0BAA0B,EAC1B,+BAA+B,SAAS,KAAK,SAAS,CAAC,KAAK,CAAC,+BAA+B,CAC7F,CAAA;gBACH,CAAC;YACH,CAAC;YACD,OAAO,SAAS,CAAA;QAClB,CAAC;KACF,CAAA;AACH,CAAC;AAMD,MAAM,UAAU,YAAY,CAAC,OAK5B;IACC,OAAO,KAAK,EAAC,WAAW,EAAC,EAAE;QACzB,MAAM,OAAO,GAA2B;YACtC,YAAY,EAAE,SAAS,CAAC,OAAO,CAAC,GAAG,CAAC;YACpC,kBAAkB,EAAE,eAAe,WAAW,EAAE;YAChD,GAAG,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,aAAa,EAAE,UAAU,OAAO,CAAC,MAAM,EAAE,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;YACxE,GAAG,CAAC,WAAW,CAAC,CAAC,CAAC,EAAE,eAAe,EAAE,IAAI,WAAW,GAAG,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;SAChE,CAAA;QACD,MAAM,QAAQ,GAAG,MAAM,OAAO,CAAC,KAAK,CAAC,GAAG,OAAO,CAAC,MAAM,uBAAuB,eAAe,EAAE,EAAE;YAC9F,MAAM,EAAE,KAAK;YACb,OAAO;YACP,MAAM,EAAE,WAAW,CAAC,OAAO,CAAC,yBAAyB,CAAC;SACvD,CAAC,CAAA;QACF,IAAI,QAAQ,CAAC,MAAM,KAAK,GAAG;YAAE,OAAO,EAAE,WAAW,EAAE,IAAI,EAAE,CAAA;QACzD,IAAI,CAAC,QAAQ,CAAC,EAAE,EAAE,CAAC;YACjB,IAAI,MAAM,GAAG,EAAE,CAAA;YACf,IAAI,CAAC;gBACH,MAAM,IAAI,GAAG,CAAC,MAAM,QAAQ,CAAC,IAAI,EAAE,CAAwB,CAAA;gBAC3D,IAAI,OAAO,IAAI,CAAC,KAAK,KAAK,QAAQ;oBAAE,MAAM,GAAG,KAAK,IAAI,CAAC,KAAK,EAAE,CAAA;YAChE,CAAC;YAAC,MAAM,CAAC;YAET,CAAC;YACD,MAAM,IAAI,KAAK,CAAC,0BAA0B,QAAQ,CAAC,MAAM,GAAG,MAAM,EAAE,CAAC,CAAA;QACvE,CAAC;QACD,MAAM,IAAI,GAAG,QAAQ,CAAC,OAAO;aAC1B,GAAG,CAAC,MAAM,CAAC;YACZ,EAAE,OAAO,CAAC,MAAM,EAAE,EAAE,CAAC;aACpB,OAAO,CAAC,UAAU,EAAE,IAAI,CAAC,CAAA;QAC5B,OAAO,EAAE,WAAW,EAAE,KAAK,EAAE,IAAI,EAAE,MAAM,QAAQ,CAAC,IAAI,EAAE,EAAE,IAAI,EAAE,IAAI,IAAI,IAAI,EAAE,CAAA;IAChF,CAAC,CAAA;AACH,CAAC;AAED,SAAS,QAAQ,CAAC,KAAc;IAC9B,OAAO,KAAK,KAAK,IAAI,IAAI,OAAO,KAAK,KAAK,QAAQ,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,CAAA;AAC7E,CAAC;AAED,SAAS,OAAO,CAAC,KAAc;IAC7B,OAAO,CACL,QAAQ,CAAC,KAAK,CAAC;QACf,OAAO,KAAK,CAAC,EAAE,KAAK,QAAQ;QAC5B,KAAK,CAAC,EAAE,CAAC,MAAM,GAAG,CAAC;QACnB,OAAO,KAAK,CAAC,KAAK,KAAK,QAAQ;QAC/B,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,KAAK,CAAC;QAC1B,KAAK,CAAC,KAAK,CAAC,KAAK,CAAC,IAAI,CAAC,EAAE,CAAC,OAAO,IAAI,KAAK,QAAQ,CAAC,CACpD,CAAA;AACH,CAAC;AAGD,MAAM,UAAU,WAAW,CAAC,IAAa,EAAE,IAAmB;IAC5D,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,IAAI,IAAI,CAAC,OAAO,KAAK,CAAC,IAAI,IAAI,CAAC,SAAS,KAAK,eAAe;QAAE,OAAO,IAAI,CAAA;IAC5F,MAAM,IAAI,GAAG,OAAO,IAAI,CAAC,IAAI,KAAK,QAAQ,IAAI,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC,IAAI,CAAA;IAC1E,IAAI,CAAC,IAAI,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,MAAM,CAAC,IAAI,IAAI,CAAC,MAAM,CAAC,MAAM,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,OAAO,CAAC;QAAE,OAAO,IAAI,CAAA;IAChH,OAAO;QACL,OAAO,EAAE,CAAC;QACV,SAAS,EAAE,eAAe;QAC1B,IAAI;QACJ,WAAW,EAAE,OAAO,IAAI,CAAC,WAAW,KAAK,QAAQ,CAAC,CAAC,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC,CAAC,EAAE;QACzE,MAAM,EAAE,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,EAAE,EAAE,EAAE,KAAK,EAAE,KAAK,EAAE,EAAE,EAAE,CAAC,CAAC,EAAE,EAAE,EAAE,KAAK,EAAE,KAAK,EAAE,CAAC,GAAG,KAAK,CAAC,EAAE,CAAC,CAAC;KACtF,CAAA;AACH,CAAC;AAUD,MAAM,UAAU,eAAe,CAAC,OAQ/B;IACC,MAAM,EAAE,MAAM,EAAE,GAAG,OAAO,CAAA;IAC1B,IAAI,OAAO,CAAC,KAAK;QAAE,OAAO,GAAG,EAAE,CAAC,SAAS,CAAA;IACzC,MAAM,KAAK,GAAG,MAAM,IAAI,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,IAAI,CAAA;IACzD,MAAM,SAAS,GAAG,KAAK,CAAC,CAAC,CAAC,cAAc,CAAC,OAAO,CAAC,GAAG,EAAE,OAAO,CAAC,MAAM,EAAE,KAAK,CAAC,CAAC,CAAC,CAAC,IAAI,CAAA;IACnF,MAAM,UAAU,GAAG,KAAK,CAAC,CAAC,CAAC,mBAAmB,CAAC,cAAc,EAAE,OAAO,CAAC,GAAG,EAAE,OAAO,CAAC,MAAM,EAAE,KAAK,CAAC,CAAC,CAAC,CAAC,IAAI,CAAA;IACzG,IAAI,SAA6B,CAAA;IACjC,IAAI,IAAI,GAAG,KAAK,CAAA;IAChB,OAAO,UAAU,CAAC,EAAE;QAClB,IAAI,CAAC,SAAS,IAAI,CAAC,UAAU,IAAI,IAAI,IAAI,CAAC,UAAU;YAAE,OAAM;QAC5D,SAAS,KAAK,aAAa,CAAC,SAAS,CAAC,IAAI,OAAO,CAAC,KAAK,CAAC,IAAI,CAAA;QAC5D,IAAI,UAAU,KAAK,SAAS;YAAE,OAAM;QAGpC,MAAM,MAAM,GAAG,UAAU,CAAC,UAAU,CAAC,CAAA;QACrC,IAAI,MAAM,EAAE,UAAU,KAAK,UAAU,IAAI,MAAM,CAAC,SAAS,KAAK,SAAS;YAAE,OAAM;QAC/E,IAAI,GAAG,IAAI,CAAA;QACX,OAAO,CAAC,IAAI,CACV,eAAe,EACf,2DAA2D,SAAS,CAAC,KAAK,CAAC,CAAC,EAAE,EAAE,CAAC,MAAM,UAAU,CAAC,KAAK,CAAC,CAAC,EAAE,EAAE,CAAC,uEAAuE,CACtL,CAAA;QACD,IAAI,CAAC;YACH,sBAAsB,CAAC,UAAU,EAAE,IAAI,CAAC,SAAS,CAAC,EAAE,SAAS,EAAE,UAAU,EAAE,CAAC,CAAC,CAAA;QAC/E,CAAC;QAAC,MAAM,CAAC;QAET,CAAC;IACH,CAAC,CAAA;AACH,CAAC;AAMD,SAAS,aAAa,CAAC,IAAY;IACjC,IAAI,CAAC;QACH,MAAM,KAAK,GAAY,IAAI,CAAC,KAAK,CAAC,YAAY,CAAC,IAAI,EAAE,MAAM,CAAC,CAAC,CAAA;QAC7D,OAAO,WAAW,CAAC,KAAK,EAAE,IAAI,CAAC,EAAE,IAAI,IAAI,IAAI,CAAA;IAC/C,CAAC;IAAC,MAAM,CAAC;QACP,OAAO,IAAI,CAAA;IACb,CAAC;AACH,CAAC;AAGD,SAAS,UAAU,CAAC,IAAY;IAC9B,IAAI,CAAC;QACH,MAAM,KAAK,GAAY,IAAI,CAAC,KAAK,CAAC,YAAY,CAAC,IAAI,EAAE,MAAM,CAAC,CAAC,CAAA;QAC7D,IAAI,CAAC,KAAK,IAAI,OAAO,KAAK,KAAK,QAAQ;YAAE,OAAO,IAAI,CAAA;QACpD,MAAM,EAAE,SAAS,EAAE,UAAU,EAAE,GAAG,KAAsD,CAAA;QACxF,OAAO,OAAO,SAAS,KAAK,QAAQ,IAAI,OAAO,UAAU,KAAK,QAAQ,CAAC,CAAC,CAAC,EAAE,SAAS,EAAE,UAAU,EAAE,CAAC,CAAC,CAAC,IAAI,CAAA;IAC3G,CAAC;IAAC,MAAM,CAAC;QACP,OAAO,IAAI,CAAA;IACb,CAAC;AACH,CAAC;AAED,SAAS,SAAS,CAAC,KAAc;IAC/B,OAAO,KAAK,YAAY,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,MAAM,CAAC,KAAK,CAAC,CAAA;AAC/D,CAAC;AAGD,SAAS,SAAS,CAAC,IAAY,EAAE,IAAiC;IAChE,IAAI,IAAY,CAAA;IAChB,IAAI,CAAC;QACH,IAAI,GAAG,YAAY,CAAC,IAAI,EAAE,MAAM,CAAC,CAAA;IACnC,CAAC;IAAC,OAAO,KAAK,EAAE,CAAC;QACf,MAAM,IAAI,GAAI,KAA+B,CAAC,IAAI,CAAA;QAClD,IAAI,IAAI,KAAK,QAAQ,IAAI,IAAI,KAAK,SAAS;YAAE,OAAO,IAAI,CAAA;QACxD,IAAI,CAAC,qBAAqB,EAAE,mCAAmC,IAAI,KAAK,SAAS,CAAC,KAAK,CAAC,2BAA2B,CAAC,CAAA;QACpH,OAAO,IAAI,CAAA;IACb,CAAC;IACD,IAAI,KAAc,CAAA;IAClB,IAAI,CAAC;QACH,KAAK,GAAG,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,CAAA;IAC1B,CAAC;IAAC,MAAM,CAAC;QACP,KAAK,GAAG,IAAI,CAAA;IACd,CAAC;IACD,MAAM,KAAK,GAAG,WAAW,CAAC,KAAK,EAAE,IAAI,CAAC,CAAA;IACtC,IAAI,CAAC,KAAK,IAAI,CAAC,QAAQ,CAAC,KAAK,CAAC,IAAI,OAAO,KAAK,CAAC,SAAS,KAAK,QAAQ,EAAE,CAAC;QAEtE,IAAI,CAAC;YACH,MAAM,CAAC,IAAI,EAAE,EAAE,KAAK,EAAE,IAAI,EAAE,CAAC,CAAA;QAC/B,CAAC;QAAC,MAAM,CAAC;QAET,CAAC;QACD,IAAI,CAAC,qBAAqB,EAAE,oBAAoB,IAAI,sCAAsC,CAAC,CAAA;QAC3F,OAAO,IAAI,CAAA;IACb,CAAC;IACD,OAAO,EAAE,KAAK,EAAE,SAAS,EAAE,KAAK,CAAC,SAAS,EAAE,CAAA;AAC9C,CAAC"}