@imagile-dev/toil 0.1.0-beta.3 → 0.1.0-beta.4

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 CHANGED
@@ -207,7 +207,7 @@ database engines sit beside the integrations, says what its level means.
207
207
  ## Toil UI
208
208
 
209
209
  **Beta, local only.** Toil UI (`@imagile-dev/toil-ui`, in [`ui/`](ui/)) is a
210
- separate package: a local web app with one dashboard per dossier, syncing through
210
+ separate package: a local web app with one dashboard per toil project, syncing through
211
211
  toil into a local cache with your own connections, read-only. It binds loopback and opens only from
212
212
  the one URL it prints when it starts. Installing toil never installs it.
213
213
  [`ui/README.md`](ui/README.md) and the
package/dist/api.d.ts CHANGED
@@ -24,7 +24,7 @@ type ErrorCode = 'INVALID_INPUT' | 'NOT_CONFIGURED' | 'CONFIG_INVALID' | 'AUTH'
24
24
  | 'UNSUPPORTED' | 'INTERNAL';
25
25
 
26
26
  /** How a transition was chosen, as meta.transition reports it. */
27
- type ResolvedBy = 'dossier' | 'status' | 'category' | 'name';
27
+ type ResolvedBy = 'toil-project' | 'status' | 'category' | 'name';
28
28
  /** meta.transition: what `--to` asked for and what it resolved to. */
29
29
  interface TransitionReport {
30
30
  intent: string;
@@ -146,7 +146,7 @@ interface ApiAnswer {
146
146
  * command read it from a file the call named, such as an `--input-file`
147
147
  * (`ctx.supply`).
148
148
  */
149
- type ContextSource = 'input' | 'file' | 'dossier' | 'git' | 'connection' | 'default';
149
+ type ContextSource = 'input' | 'file' | 'toil-project' | 'git' | 'connection' | 'default';
150
150
  interface ContextValue {
151
151
  value: string;
152
152
  source: ContextSource;
@@ -154,33 +154,33 @@ interface ContextValue {
154
154
  via?: string;
155
155
  /** For `connection` from the default: named in `defaults.<area>`, named after the area, or the only one. */
156
156
  default?: 'named' | 'area-name' | 'only';
157
- /** For `connection` from a dossier's host selector: the host it matched. A selector, never contacted. */
157
+ /** For `connection` from a toil project's host selector: the host it matched. A selector, never contacted. */
158
158
  host?: string;
159
159
  /** For `connection`, in an area that serves more than one deployment (`jira`): which one ran, `server` or `cloud`. */
160
160
  deployment?: string;
161
161
  }
162
- /** The dossier a call used (docs/dossiers.md), and how it was found. Never a value from a connection. */
163
- interface DossierReport {
162
+ /** The toil project a call used (docs/projects.md), and how it was found. Never a value from a connection. */
163
+ interface ToilProjectReport {
164
164
  name: string;
165
165
  /** Where it lives: your own folder, a listed folder, the repository you're in, or a file named on the call. */
166
166
  source: 'user' | 'listed' | 'repo' | 'file';
167
167
  /** The file, absolute, with forward slashes. */
168
168
  file: string;
169
- /** What chose it: the call's `dossier` input, TOIL_DOSSIER, or the folder. */
169
+ /** What chose it: the call's `toilProject` input, TOIL_PROJECT, or the folder. */
170
170
  by: 'input' | 'env' | 'folder';
171
- /** How the folder matched it: a repo's path, a repo's remote, or a dossier checked into the folder's repository. */
171
+ /** How the folder matched it: a repo's path, a repo's remote, or a toil project checked into the folder's repository. */
172
172
  match?: 'path' | 'remote' | 'checked-in';
173
- /** The dossier's repo the folder is, when one matched. */
173
+ /** The toil project's repo the folder is, when one matched. */
174
174
  repo?: string;
175
- /** The folder, when it chose the dossier or the call named one: the `cwd` input, or where the workspace came from. */
175
+ /** The folder, when it chose the toil project or the call named one: the `cwd` input, or where the workspace came from. */
176
176
  folder?: {
177
177
  path: string;
178
178
  from: 'input' | 'flag' | 'env' | 'cwd' | 'mcp-root';
179
179
  };
180
180
  }
181
181
  interface ContextReport {
182
- /** The dossier that supplied context, when one applied. */
183
- dossier?: DossierReport;
182
+ /** The toil project that supplied context, when one applied. */
183
+ toilProject?: ToilProjectReport;
184
184
  connection?: ContextValue;
185
185
  /** Each context input that resolved. Absent when none did. */
186
186
  inputs?: Record<string, ContextValue>;
@@ -738,7 +738,7 @@ interface CommandInfo {
738
738
  description: string;
739
739
  /** Every call writes: refused under `readOnly`, and gated by `writes` plus `allowWrite` otherwise. */
740
740
  writes: boolean;
741
- /** Every call changes something on this machine (toil's config or dossiers, a download): refused under `readOnly`. */
741
+ /** Every call changes something on this machine (toil's config or toil projects, a download): refused under `readOnly`. */
742
742
  writesLocal: boolean;
743
743
  /** Some calls write, depending on the input (the raw passthrough's POST, a file named with `out`); those are refused under `readOnly`. */
744
744
  writesDependOnInput: boolean;
@@ -790,8 +790,8 @@ interface Registry {
790
790
  * `confirm-name` (type the connection's name to turn writes on), `unwrap:<key>`
791
791
  * (the secret for `<key>` is in quotes or starts with `Bearer ` or `token `:
792
792
  * `y` stores it without them, `n` as entered; `checkSecret` says which before
793
- * the call, so a host can ask its person first), for `dossiers onboard`
794
- * `create:<section>` (add a connection that dossier section needs: `y` or `n`),
793
+ * the call, so a host can ask its person first), for `toil projects onboard`
794
+ * `create:<section>` (add a connection that toil project section needs: `y` or `n`),
795
795
  * `name:<section>` (the new connection's name) and `pin:<section>` (which
796
796
  * matching connection the person's own copy uses), and `consent`
797
797
  * (`feedback`: send the report and disclaimer the question shows to Imagile
@@ -821,7 +821,7 @@ interface ExecuteOptions {
821
821
  /**
822
822
  * Refuse the call, before anything resolves or is sent, if it would change
823
823
  * anything: a write to a service, or on this machine (toil's config or
824
- * dossiers, a download, a file named with `out`). The refusal is
824
+ * toil projects, a download, a file named with `out`). The refusal is
825
825
  * `WRITE_DISABLED`, whatever the config says. A read-only call writes
826
826
  * nothing but its audit line.
827
827
  */
@@ -883,7 +883,7 @@ declare function execute(command: string, input?: Record<string, unknown>, optio
883
883
  * holds envelopes: the same mapping `util owi map` does, in-process and
884
884
  * synchronous. `input` is envelopes (one, an array, or JSON or JSON Lines
885
885
  * text), or a command's bare `data` with `command` named; `fields` is a
886
- * dossier section's `fields` object (`{ estimate: "customfield_10234",
886
+ * toil project section's `fields` object (`{ estimate: "customfield_10234",
887
887
  * estimateUnit: "points" }`). It doesn't validate against the schema the way
888
888
  * `execute('util owi map', …)` does, which runs the check in a worker; use
889
889
  * that, or `owiSchema`, to check. Refusals (an override OWI has no field for,
@@ -891,7 +891,7 @@ declare function execute(command: string, input?: Record<string, unknown>, optio
891
891
  */
892
892
  declare function mapOwi(input: unknown, options?: OwiMapOptions): OwiResult;
893
893
  interface OwiMapOptions {
894
- /** OWI fields pointed at a team's own fields: a dossier section's `fields`, or `name=field` strings. */
894
+ /** OWI fields pointed at a team's own fields: a toil project section's `fields`, or `name=field` strings. */
895
895
  fields?: Record<string, string> | string[];
896
896
  /** The command whose bare `data` the input is (`jira issue search`). */
897
897
  command?: string;
@@ -930,4 +930,4 @@ declare const owiSchema: Record<string, unknown>;
930
930
  */
931
931
  declare function checkSecret(raw: string, rules: SecretRules): SecretCheck;
932
932
 
933
- export { type ApiAnswer, type AreaSummary, type AuthorKind, type AuthorKindSource, type Body, type Change, type ChangeSize, type ChangeState, type ChecksState, type CommandInfo, type CommandKind, type ConnectionField, type ContextReport, type ContextSource, type ContextValue, type DossierReport, type Envelope, type ErrorBody, type ErrorCode, type Estimate, type EstimateUnit, type ExecuteOptions, type ExecutePerson, type FieldOverrides, type History, type Iteration, type IterationChange, type KeyPattern, type Link, type LinkType, type Meta, type OrphanHistory, type OwiMapOptions, type OwiResult, type OwiSkipped, type Page, type PageProgress, type PairSearch, type Person, type ProgressEvent, type Question, type Registry, type RequestProgress, type RetryProgress, type Review, type ReviewState, type Reviewer, type ReviewerState, type SecretCheck, type SecretRules, type SecretWrapper, type SimilarField, type SimilarItem, type SimilarMatch, type SimilarOptions, type SimilarPair, type SimilarParts, type SimilarRef, type SimilarRequest, type SimilarResult, type SimilarWhy, type StatusCategory, type Transition, type Unmapped, type Warning, type WorkItem, type WorkItemType, checkSecret, contractVersion, execute, findSimilar, mapOwi, owiSchema, owiVersion, registry, version };
933
+ export { type ApiAnswer, type AreaSummary, type AuthorKind, type AuthorKindSource, type Body, type Change, type ChangeSize, type ChangeState, type ChecksState, type CommandInfo, type CommandKind, type ConnectionField, type ContextReport, type ContextSource, type ContextValue, type Envelope, type ErrorBody, type ErrorCode, type Estimate, type EstimateUnit, type ExecuteOptions, type ExecutePerson, type FieldOverrides, type History, type Iteration, type IterationChange, type KeyPattern, type Link, type LinkType, type Meta, type OrphanHistory, type OwiMapOptions, type OwiResult, type OwiSkipped, type Page, type PageProgress, type PairSearch, type Person, type ProgressEvent, type Question, type Registry, type RequestProgress, type RetryProgress, type Review, type ReviewState, type Reviewer, type ReviewerState, type SecretCheck, type SecretRules, type SecretWrapper, type SimilarField, type SimilarItem, type SimilarMatch, type SimilarOptions, type SimilarPair, type SimilarParts, type SimilarRef, type SimilarRequest, type SimilarResult, type SimilarWhy, type StatusCategory, type ToilProjectReport, type Transition, type Unmapped, type Warning, type WorkItem, type WorkItemType, checkSecret, contractVersion, execute, findSimilar, mapOwi, owiSchema, owiVersion, registry, version };