snipara-companion 1.3.7 → 1.3.8
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +25 -0
- package/dist/index.d.ts +86 -1
- package/dist/index.js +725 -234
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -472,6 +472,8 @@ snipara-companion upload --path docs/spec.md --file ./docs/spec.md
|
|
|
472
472
|
snipara-companion upload --path clients/acme/current.md --file ./current.md --asset-class BUSINESS_DOCUMENT --usage-mode current_truth --source-kind local_agent --client-id acme
|
|
473
473
|
snipara-companion upload --path diagrams/network.vsdx --file ./diagrams/network.vsdx --kind BINARY --format vsdx --reindex
|
|
474
474
|
snipara-companion upload --path docs/spec.md --file ./docs/spec.md --reindex
|
|
475
|
+
snipara-companion references scan --allow-domain docs.stripe.com --allow-domain docs.github.com
|
|
476
|
+
snipara-companion references ingest --upload --reindex
|
|
475
477
|
snipara-companion business-collections list
|
|
476
478
|
snipara-companion business-collections ensure --preset business_response_playbook
|
|
477
479
|
snipara-companion business-collections ensure --preset offer_templates
|
|
@@ -565,6 +567,29 @@ snipara-companion task-commit --summary "Validated PR Answer Pack release docs"
|
|
|
565
567
|
Only add a dedicated `snipara-companion github answer-packs` command if Snipara
|
|
566
568
|
ships a public API for manual regeneration or inspection outside the dashboard.
|
|
567
569
|
|
|
570
|
+
### External References
|
|
571
|
+
|
|
572
|
+
Use `references` when repository docs point at source material the agent may not
|
|
573
|
+
be able to fetch directly, such as SDK docs, vendor runbooks, RFCs, or client
|
|
574
|
+
pages:
|
|
575
|
+
|
|
576
|
+
```bash
|
|
577
|
+
snipara-companion references scan \
|
|
578
|
+
--allow-domain docs.stripe.com \
|
|
579
|
+
--allow-domain docs.github.com
|
|
580
|
+
|
|
581
|
+
snipara-companion references ingest --dry-run
|
|
582
|
+
snipara-companion references ingest --upload --reindex
|
|
583
|
+
```
|
|
584
|
+
|
|
585
|
+
`scan` writes `.snipara/references/manifest.json` with each URL, source file,
|
|
586
|
+
line number, domain, and allowlist status. URLs are only ingested when their
|
|
587
|
+
domain is allowlisted in the manifest or passed with `--allow-domain` at ingest
|
|
588
|
+
time. `ingest` fetches allowed URLs into local Markdown snapshots under
|
|
589
|
+
`.snipara/references/snapshots/`; `--upload` sends those snapshots to Snipara as
|
|
590
|
+
external reference documents with source URL, content hash, fetch time, HTTP
|
|
591
|
+
metadata, and referenced-from provenance.
|
|
592
|
+
|
|
568
593
|
### Project Intelligence Briefs
|
|
569
594
|
|
|
570
595
|
Use `intelligence brief` when a task needs one local entrypoint for continuity,
|
package/dist/index.d.ts
CHANGED
|
@@ -1640,6 +1640,91 @@ declare function buildAgenticTimeline(options?: {
|
|
|
1640
1640
|
cwd?: string;
|
|
1641
1641
|
}): AgenticTimeline;
|
|
1642
1642
|
|
|
1643
|
+
declare const MANIFEST_VERSION = "snipara.references.v1";
|
|
1644
|
+
type ReferenceStatus = "allowed" | "pending" | "denied" | "unsupported";
|
|
1645
|
+
interface ReferenceOccurrence {
|
|
1646
|
+
file: string;
|
|
1647
|
+
line: number;
|
|
1648
|
+
label?: string;
|
|
1649
|
+
}
|
|
1650
|
+
interface ReferenceManifestItem {
|
|
1651
|
+
id: string;
|
|
1652
|
+
url: string;
|
|
1653
|
+
normalizedUrl: string;
|
|
1654
|
+
domain: string;
|
|
1655
|
+
status: ReferenceStatus;
|
|
1656
|
+
reason: string;
|
|
1657
|
+
discoveredAt: string;
|
|
1658
|
+
occurrences: ReferenceOccurrence[];
|
|
1659
|
+
latestSnapshotPath?: string;
|
|
1660
|
+
latestFetchStatus?: number;
|
|
1661
|
+
latestFetchAt?: string;
|
|
1662
|
+
latestContentHash?: string;
|
|
1663
|
+
latestError?: string;
|
|
1664
|
+
}
|
|
1665
|
+
interface ReferenceManifest {
|
|
1666
|
+
version: typeof MANIFEST_VERSION;
|
|
1667
|
+
generatedAt: string;
|
|
1668
|
+
root: string;
|
|
1669
|
+
allowDomains: string[];
|
|
1670
|
+
denyDomains: string[];
|
|
1671
|
+
items: ReferenceManifestItem[];
|
|
1672
|
+
}
|
|
1673
|
+
interface ScanReferencesOptions {
|
|
1674
|
+
root?: string;
|
|
1675
|
+
output?: string;
|
|
1676
|
+
allowDomain?: string[];
|
|
1677
|
+
denyDomain?: string[];
|
|
1678
|
+
extensions?: string[];
|
|
1679
|
+
maxFiles?: number;
|
|
1680
|
+
json?: boolean;
|
|
1681
|
+
}
|
|
1682
|
+
interface IngestReferencesOptions {
|
|
1683
|
+
manifest?: string;
|
|
1684
|
+
outputDir?: string;
|
|
1685
|
+
allowDomain?: string[];
|
|
1686
|
+
ids?: string[];
|
|
1687
|
+
max?: number;
|
|
1688
|
+
timeoutMs?: number;
|
|
1689
|
+
maxBytes?: number;
|
|
1690
|
+
destinationPrefix?: string;
|
|
1691
|
+
upload?: boolean;
|
|
1692
|
+
reindex?: boolean;
|
|
1693
|
+
dryRun?: boolean;
|
|
1694
|
+
json?: boolean;
|
|
1695
|
+
}
|
|
1696
|
+
interface ScanSummary {
|
|
1697
|
+
manifest: ReferenceManifest;
|
|
1698
|
+
outputPath: string;
|
|
1699
|
+
scannedFiles: number;
|
|
1700
|
+
foundUrls: number;
|
|
1701
|
+
allowed: number;
|
|
1702
|
+
pending: number;
|
|
1703
|
+
denied: number;
|
|
1704
|
+
unsupported: number;
|
|
1705
|
+
}
|
|
1706
|
+
interface IngestSummary {
|
|
1707
|
+
manifestPath: string;
|
|
1708
|
+
selected: number;
|
|
1709
|
+
fetched: number;
|
|
1710
|
+
uploaded: number;
|
|
1711
|
+
failed: number;
|
|
1712
|
+
dryRun: boolean;
|
|
1713
|
+
snapshots: Array<{
|
|
1714
|
+
id: string;
|
|
1715
|
+
url: string;
|
|
1716
|
+
snapshotPath?: string;
|
|
1717
|
+
destinationPath?: string;
|
|
1718
|
+
status?: number;
|
|
1719
|
+
uploaded?: boolean;
|
|
1720
|
+
error?: string;
|
|
1721
|
+
}>;
|
|
1722
|
+
}
|
|
1723
|
+
declare function scanReferences(options?: ScanReferencesOptions): ScanSummary;
|
|
1724
|
+
declare function ingestReferences(options?: IngestReferencesOptions): Promise<IngestSummary>;
|
|
1725
|
+
declare function referencesScanCommand(options: ScanReferencesOptions): Promise<void>;
|
|
1726
|
+
declare function referencesIngestCommand(options: IngestReferencesOptions): Promise<void>;
|
|
1727
|
+
|
|
1643
1728
|
type CacheStrategy = "exact" | "nearby" | "warm";
|
|
1644
1729
|
interface QueryCacheScope {
|
|
1645
1730
|
cwd?: string;
|
|
@@ -2062,4 +2147,4 @@ interface WrittenOrchestratorHandoff {
|
|
|
2062
2147
|
declare function buildOrchestratorHandoff(options: OrchestratorHandoffOptions): OrchestratorHandoffArtifact;
|
|
2063
2148
|
declare function writeOrchestratorHandoff(options: OrchestratorHandoffOptions): WrittenOrchestratorHandoff;
|
|
2064
2149
|
|
|
2065
|
-
export { AUTOMATION_MANIFEST_RELATIVE_PATH, AutomationInstallConflictError, AutomationUnsupportedHookBundleError, ORCHESTRATOR_HANDOFF_RELATIVE_PATH, TEAM_SYNC_STATE_RELATIVE_PATH, WORKFLOW_PLANS_RELATIVE_DIR, WORKFLOW_STATE_RELATIVE_PATH, archiveInactiveTeamSyncWork, autoArchiveTeamSyncState, buildAgenticHandoffMarkdown, buildAgenticTimeline, buildAgenticWorkStatus, buildAutomationInstallPlan, buildCanonicalEvent, buildCodeHooksInstallPlan, buildCodePromotionResult, buildCodeStatusResult, buildCodeSyncResult, buildHostedCodeOverlayUploadPayload, buildJournalCheckpointEntry, buildLocalCallersResult, buildLocalCodeOverlay, buildLocalImpactResult, buildLocalImportsResult, buildLocalNeighborsResult, buildLocalShortestPathResult, buildMemoryAudit, buildOnboardFolderManifest, buildOrchestratorHandoff, buildProjectIntelligenceBrief, buildSyncDocumentsDryRun, buildTeamSyncHandoffRecord, buildTeamSyncStartWorkRecord, buildTeamSyncSummary, buildToolCallPayload, buildToolResultPayload, buildVerificationPlan, buildWorkflowPhaseCommitSummary, buildWorkflowPlanScaffold, categoryFromGuardTag, classifyToolResult, collectSyncDocuments, collectSyncDocumentsInput, createClient, createEmptyTeamSyncState, createLocalQueryCache, detectReleaseSurfacesFromFiles, detectRuntimeEnvironment, extractCommandFromToolInput, extractFilesFromToolInput, formatOrchestratorRecommendationReason, formatStuckGuardDecision, getAutomationManifestPath, getAutomationStatus, getConfigPath, getLocalCodeOverlayCachePath, getLocalCodePromotionStatePath, getOrchestratorRecommendation, getPlanStepDisplayTitle, getStagedFiles, getStuckGuardInjection, getTeamSyncStatePath, installAutomationBundle, listProjectsForApiKey, loadAutomationManifest, loadConfig, loadTeamSyncState, memoryAuditCommand, memoryCleanCandidatesCommand, memoryCompactCommand, memoryHealthCommand, normalizeGuardTag, normalizeWorkflowPlanInput, projectIntelligenceBriefCommand, readLocalCodeOverlayCache, readLocalCodePromotionState, resolveQueryFromToolInput, runMemoryGuardCheck, saveConfig, saveTeamSyncState, shouldSuggestOrchestratorForWorkflow, shouldSuggestRuntimeForWorkflow, summarizeLocalCodeOverlay, teamSyncSweepCommand, verifyCommand, writeLocalCodeOverlayCache, writeLocalCodePromotionState, writeOrchestratorHandoff };
|
|
2150
|
+
export { AUTOMATION_MANIFEST_RELATIVE_PATH, AutomationInstallConflictError, AutomationUnsupportedHookBundleError, ORCHESTRATOR_HANDOFF_RELATIVE_PATH, TEAM_SYNC_STATE_RELATIVE_PATH, WORKFLOW_PLANS_RELATIVE_DIR, WORKFLOW_STATE_RELATIVE_PATH, archiveInactiveTeamSyncWork, autoArchiveTeamSyncState, buildAgenticHandoffMarkdown, buildAgenticTimeline, buildAgenticWorkStatus, buildAutomationInstallPlan, buildCanonicalEvent, buildCodeHooksInstallPlan, buildCodePromotionResult, buildCodeStatusResult, buildCodeSyncResult, buildHostedCodeOverlayUploadPayload, buildJournalCheckpointEntry, buildLocalCallersResult, buildLocalCodeOverlay, buildLocalImpactResult, buildLocalImportsResult, buildLocalNeighborsResult, buildLocalShortestPathResult, buildMemoryAudit, buildOnboardFolderManifest, buildOrchestratorHandoff, buildProjectIntelligenceBrief, buildSyncDocumentsDryRun, buildTeamSyncHandoffRecord, buildTeamSyncStartWorkRecord, buildTeamSyncSummary, buildToolCallPayload, buildToolResultPayload, buildVerificationPlan, buildWorkflowPhaseCommitSummary, buildWorkflowPlanScaffold, categoryFromGuardTag, classifyToolResult, collectSyncDocuments, collectSyncDocumentsInput, createClient, createEmptyTeamSyncState, createLocalQueryCache, detectReleaseSurfacesFromFiles, detectRuntimeEnvironment, extractCommandFromToolInput, extractFilesFromToolInput, formatOrchestratorRecommendationReason, formatStuckGuardDecision, getAutomationManifestPath, getAutomationStatus, getConfigPath, getLocalCodeOverlayCachePath, getLocalCodePromotionStatePath, getOrchestratorRecommendation, getPlanStepDisplayTitle, getStagedFiles, getStuckGuardInjection, getTeamSyncStatePath, ingestReferences, installAutomationBundle, listProjectsForApiKey, loadAutomationManifest, loadConfig, loadTeamSyncState, memoryAuditCommand, memoryCleanCandidatesCommand, memoryCompactCommand, memoryHealthCommand, normalizeGuardTag, normalizeWorkflowPlanInput, projectIntelligenceBriefCommand, readLocalCodeOverlayCache, readLocalCodePromotionState, referencesIngestCommand, referencesScanCommand, resolveQueryFromToolInput, runMemoryGuardCheck, saveConfig, saveTeamSyncState, scanReferences, shouldSuggestOrchestratorForWorkflow, shouldSuggestRuntimeForWorkflow, summarizeLocalCodeOverlay, teamSyncSweepCommand, verifyCommand, writeLocalCodeOverlayCache, writeLocalCodePromotionState, writeOrchestratorHandoff };
|