"api-helper/goal/chooseAndSetGoals"

Index

Interfaces

ChooseAndSetGoalsRules

Functions

chooseAndSetGoals

chooseAndSetGoals(rules: ChooseAndSetGoalsRules, parameters: { context: HandlerContext; credentials: ProjectOperationCredentials; push: Fragment }): Promise<Goals | undefined>

- Defined in lib/api-helper/goal/chooseAndSetGoals.ts:122
Choose and set goals for this push

Parameters
- rules: ChooseAndSetGoalsRules
- parameters: { context: HandlerContext; credentials: ProjectOperationCredentials; push: Fragment }
  
  details of incoming request
  - context: HandlerContext
  - credentials: ProjectOperationCredentials
  - push: Fragment
Returns Promise<Goals | undefined>

chooseGoalsForPushOnProject

chooseGoalsForPushOnProject(rules: { goalSetter: GoalSetter }, pi: PushListenerInvocation): Promise<Goals>

- Defined in lib/api-helper/goal/chooseAndSetGoals.ts:303
Parameters
- rules: { goalSetter: GoalSetter }
  - goalSetter: GoalSetter
- pi: PushListenerInvocation
Returns Promise<Goals>

createGoal

createGoal(g: PlannedGoal, dg: Goal, preConditions: string | string[], plannedGoalsCounter: number, previousGoals: Goal[], goalMapping: Map<string, Goal[]>): Goal

- Defined in lib/api-helper/goal/chooseAndSetGoals.ts:425
Parameters
- g: PlannedGoal
- dg: Goal
- preConditions: string | string[]
- plannedGoalsCounter: number
- previousGoals: Goal[]
- goalMapping: Map<string, Goal[]>
Returns Goal

determineGoals

determineGoals(rules: { enrichGoal: EnrichGoal; goalSetter: GoalSetter; implementationMapping: GoalImplementationMapper; projectLoader: ProjectLoader; repoRefResolver: RepoRefResolver; tagGoalSet?: TagGoalSet }, circumstances: { addressChannels: AddressChannels; configuration: Configuration; context: HandlerContext; credentials: ProjectOperationCredentials; goalSetId: string; id: RemoteRepoRef; preferences?: PreferenceStore; push: Fragment }): Promise<{ determinedGoals: Goals | undefined; goalsToSave: SdmGoalMessage[]; tags: GoalSetTag[] }>

- Defined in lib/api-helper/goal/chooseAndSetGoals.ts:170
Parameters
- rules: { enrichGoal: EnrichGoal; goalSetter: GoalSetter; implementationMapping: GoalImplementationMapper; projectLoader: ProjectLoader; repoRefResolver: RepoRefResolver; tagGoalSet?: TagGoalSet }
  - enrichGoal: EnrichGoal
  - goalSetter: GoalSetter
  - implementationMapping: GoalImplementationMapper
  - projectLoader: ProjectLoader
  - repoRefResolver: RepoRefResolver
  - Optional tagGoalSet?: TagGoalSet
- circumstances: { addressChannels: AddressChannels; configuration: Configuration; context: HandlerContext; credentials: ProjectOperationCredentials; goalSetId: string; id: RemoteRepoRef; preferences?: PreferenceStore; push: Fragment }
  - addressChannels: AddressChannels
  - configuration: Configuration
  - context: HandlerContext
  - credentials: ProjectOperationCredentials
  - goalSetId: string
  - id: RemoteRepoRef
  - Optional preferences?: PreferenceStore
  - push: Fragment
Returns Promise<{ determinedGoals: Goals | undefined; goalsToSave: SdmGoalMessage[]; tags: GoalSetTag[] }>

fulfillment

fulfillment(rules: { implementationMapping: GoalImplementationMapper }, g: Goal, inv: PushListenerInvocation): Promise<SdmGoalFulfillment>

- Defined in lib/api-helper/goal/chooseAndSetGoals.ts:276
Parameters
- rules: { implementationMapping: GoalImplementationMapper }
  - implementationMapping: GoalImplementationMapper
- g: Goal
- inv: PushListenerInvocation
Returns Promise<SdmGoalFulfillment>

planGoals

planGoals(goals: Goals, pli: PushListenerInvocation): Promise<Goals>

- Defined in lib/api-helper/goal/chooseAndSetGoals.ts:347
Parameters
- goals: Goals
- pli: PushListenerInvocation
Returns Promise<Goals>

sdmGoalsFromGoals

sdmGoalsFromGoals(implementationMapping: GoalImplementationMapper, push: Fragment, repoRefResolver: RepoRefResolver, pli: PushListenerInvocation, determinedGoals: Goals, goalSetId: string): Promise<SdmGoalMessage[]>

- Defined in lib/api-helper/goal/chooseAndSetGoals.ts:240
Parameters
- implementationMapping: GoalImplementationMapper
- push: Fragment
- repoRefResolver: RepoRefResolver
- pli: PushListenerInvocation
- determinedGoals: Goals
- goalSetId: string
Returns Promise<SdmGoalMessage[]>

Index

Interfaces

Functions

Functions

chooseAndSetGoals

Parameters

rules: ChooseAndSetGoalsRules

parameters: { context: HandlerContext; credentials: ProjectOperationCredentials; push: Fragment }

context: HandlerContext

credentials: ProjectOperationCredentials

push: Fragment

Returns Promise<Goals | undefined>

chooseGoalsForPushOnProject

Parameters

rules: { goalSetter: GoalSetter }

goalSetter: GoalSetter

pi: PushListenerInvocation

Returns Promise<Goals>

createGoal

Parameters

g: PlannedGoal

dg: Goal

preConditions: string | string[]

plannedGoalsCounter: number

previousGoals: Goal[]

goalMapping: Map<string, Goal[]>

Returns Goal

determineGoals

Parameters

rules: { enrichGoal: EnrichGoal; goalSetter: GoalSetter; implementationMapping: GoalImplementationMapper; projectLoader: ProjectLoader; repoRefResolver: RepoRefResolver; tagGoalSet?: TagGoalSet }

enrichGoal: EnrichGoal

goalSetter: GoalSetter

implementationMapping: GoalImplementationMapper

projectLoader: ProjectLoader

repoRefResolver: RepoRefResolver

Optional tagGoalSet?: TagGoalSet

circumstances: { addressChannels: AddressChannels; configuration: Configuration; context: HandlerContext; credentials: ProjectOperationCredentials; goalSetId: string; id: RemoteRepoRef; preferences?: PreferenceStore; push: Fragment }

addressChannels: AddressChannels

configuration: Configuration

context: HandlerContext

credentials: ProjectOperationCredentials

goalSetId: string

id: RemoteRepoRef

Optional preferences?: PreferenceStore

push: Fragment

Returns Promise<{ determinedGoals: Goals | undefined; goalsToSave: SdmGoalMessage[]; tags: GoalSetTag[] }>

fulfillment

Parameters

rules: { implementationMapping: GoalImplementationMapper }

implementationMapping: GoalImplementationMapper

g: Goal

inv: PushListenerInvocation

Returns Promise<SdmGoalFulfillment>

planGoals

Parameters

goals: Goals

pli: PushListenerInvocation

Returns Promise<Goals>

sdmGoalsFromGoals

Parameters

implementationMapping: GoalImplementationMapper

push: Fragment

repoRefResolver: RepoRefResolver

pli: PushListenerInvocation

determinedGoals: Goals

goalSetId: string

Returns Promise<SdmGoalMessage[]>