@atomist/clj-editors/index.d.ts

editor functions that use rewrite-clj and other important things from the clojurescript ecosystem

/**
 * clojure-sdm editors
 */
export declare function setVersion( f: string, version: string): Promise<any>
export declare function getVersion( f: string): string
export declare function getName( f: string): string
export declare function projectDeps( f: string): void
export declare function cljfmt(f: string): Promise<any>
export declare function updateProjectDep( f: string, libname: string, version: string): void
export declare function vault( key: string, f: string): Map<string,string>

/**
 * Types:  project Fingerprint types
 */
export declare interface FP {name: string, sha: string, data: any, version: string, abbreviation: string}

/**
 * Clojure fingerprint computations and editors
 */
export declare function fingerprint( f1:string ): Promise<FP[]>
export declare function edit(f1:string,n:string,v:string): void

/**
 * Utility functions to rewrite in typescript
 */
export declare function renderDiff( diff: Diff): string
export declare function renderOptions( options: {text: string, value: string}[]): string
export declare function renderData(x: any): string
export declare function sha256( data: string): string

/**
 * Fingerprint Push Impact support function - processPushImpact
 * (to rewrite in typescript someday)
 */
export declare interface DiffData {from: any[], to: any[]}
export declare interface Diff {from: FP, to: FP, data: DiffData, owner: string, repo: string, channel: string}
export declare interface Handler {selector: (a:FP) => boolean,
                                  action?: (b:Diff) => void,
                                  diffAction?: (b:Diff) => void}
// event is the PushImpact subscription data
// getFingerprintData returns application/json - return "{}" if data is empty
// handlers select and action the push impacts for different fingerprints
export declare function processPushImpact(event: any,
                                          getFingerprintData: (sha: string, name: string) => Promise<string>,
                                          handlers: Handler[]): Promise<boolean>

/**
 * Library Dependency Goals Support functions
 * (to rewrite in typescript someday)
 */
// sendMessage about library targets from project which may contain lib dependencies (get library targets)
// we use this to check current library goals and possibly set some ones based on the current versions
export declare function withProjectGoals(queryPreferences: () => Promise<any>,
                                         basedir: string,
                                         sendMessage: (text: string, options: {text: string, value: string}[]) => Promise<void>): Promise<boolean>

// callback with library targets from project which may contain lib dependencies
export declare function withPreferences(queryPreferences: () => Promise<any>,
                                        callback: (options: {text: string, value: string}[]) => Promise<void>): Promise<boolean>

// choose a new library target and set it in the team wide preferences
// we use this to set a new library goal
export declare function withNewGoal(queryPreferences: () => Promise<any>,
                                    mutatePreference: (chatTeamId: string, prefsAsJson: string) => Promise<any>,
                                    library: {name: string, version: string} | string): Promise<boolean>

// send a message if any libraries in the updated project are not the target versions
// we use this to check whether a library is in sync with the current goals
export declare function checkLibraryGoals(queryPreferences: () => Promise<any>,
                                          sendMessage: (s: string, library: {library: {name: string, version: string}, current: string}) => Promise<any>,
                                          diff: Diff): Promise<boolean>

// fire callbacks for all project consuming a library when a new library target is set
// we use this to broadcast a new library goal to all projects that might be impacted
export declare function broadcast( queryFingerprints: (name: string) => Promise<any>,
                                   library: {name: string, version: string},
                                   callback: (owner: string, repo: string, channel: string) => Promise<any>): Promise<any>