@promptbook/google
Version:
Promptbook: Create persistent AI agents that turn your company's scattered knowledge into action
35 lines (34 loc) • 1.53 kB
TypeScript
import type { InitializationStatus } from './boilerplateTemplates';
/**
* Status of one default Book or artifact referenced by the default coder scripts.
*
* `not-referenced` means that no newly added script points at the artifact, so `ptbk coder init` left it alone.
*
* @private internal utility of `coder init` command
*/
export type CoderReferencedArtifactStatus = InitializationStatus | 'augmented' | 'unresolved' | 'not-referenced';
/**
* Result of ensuring one default Book or artifact referenced by the default coder scripts.
*
* @private internal utility of `coder init` command
*/
export type EnsuredCoderReferencedArtifact = {
/**
* Project-relative path of the referenced artifact.
*/
readonly relativeFilePath: string;
/**
* Status describing whether the artifact was created, augmented, preserved, or could not be resolved.
*/
readonly status: CoderReferencedArtifactStatus;
/** Explanation of an unresolved file or TEAM declaration, with the original content preserved. */
readonly diagnostic?: string;
};
/**
* Initializes essential context and artifacts referenced by freshly added scripts. Books are ensured separately.
*
* AGENTS.md is essential even when every script already exists or uses implicit defaults.
*
* @private function of `initializeCoderProjectConfiguration`
*/
export declare function ensureCoderReferencedArtifacts(projectPath: string, referencedArtifactPaths: ReadonlySet<string>): Promise<ReadonlyArray<EnsuredCoderReferencedArtifact>>;