@shipfox/expression 1.2.0 → 2.0.0

package/dist/workflow-context/workflow-context-docs.d.ts

@@ -0,0 +1,185 @@
+import type { WorkflowContextName } from './workflow-context.js';
+/**
+ * Reader-facing descriptions for every context root and property.
+ *
+ * They live beside the type registry so a new field cannot ship undescribed:
+ * the documentation generator renders types from the registry and looks up each
+ * property here, and its check fails on a property with no description or a
+ * description for a property that no longer exists.
+ */
+export interface WorkflowContextDoc {
+    readonly root: WorkflowContextName;
+    readonly summary: string;
+    /** Why an open-shape root has no property table. */
+    readonly shapeNote?: string;
+    /** Prefix shown in the property column, such as `needs[*].`. */
+    readonly propertyPrefix?: string;
+    /** Description per property path, relative to the root. */
+    readonly fields?: Readonly<Record<string, string>>;
+    /** Paths whose element shape another root already documents. */
+    readonly collapse?: readonly string[];
+}
+export declare const workflowContextDocs: readonly [{
+    readonly root: "workflow";
+    readonly summary: "The workflow definition this run came from.";
+    readonly fields: {
+        readonly id: "Identifier of the workflow definition.";
+        readonly name: "Workflow `name` from the definition.";
+    };
+}, {
+    readonly root: "run";
+    readonly summary: "The current run.";
+    readonly fields: {
+        readonly id: "Identifier of the run.";
+        readonly number: "Sequential run number within the workflow definition.";
+        readonly name: "Resolved run name, or the workflow name when `run_name` is not set.";
+        readonly project_id: "Identifier of the project that owns the run.";
+        readonly workspace_id: "Identifier of the workspace that owns the run.";
+        readonly created_at: "Time the run was created.";
+    };
+}, {
+    readonly root: "trigger";
+    readonly summary: "The trigger that started the run.";
+    readonly fields: {
+        readonly source: "Integration connection slug, or `manual` or `cron`.";
+        readonly event: "Shipfox event name that matched the trigger.";
+        readonly project: "Shipfox project resolved from the event repository. Null when there is none.";
+        readonly 'project.id': "Identifier of the resolved project.";
+        readonly repository: "Repository the event came from, as `owner/name`. Null when there is none.";
+        readonly ref: "Git ref the event carried. Null when there is none.";
+        readonly commit: "Commit SHA the event carried. Null when there is none.";
+    };
+}, {
+    readonly root: "event";
+    readonly summary: "The raw payload of the event that started the run.";
+    readonly shapeNote: "The provider owns this payload, so it has no fixed shape. Each provider page under [Integrations](/integrations) lists the events Shipfox delivers and links the payload each one carries.";
+}, {
+    readonly root: "inputs";
+    readonly summary: "Values the trigger `with` block passed into the run.";
+    readonly shapeNote: "The keys are the ones the trigger declares. See [trigger fields](/reference/workflow-schema#trigger-fields).";
+}, {
+    readonly root: "job";
+    readonly summary: "The current job.";
+    readonly fields: {
+        readonly key: "Key of the job in the `jobs` map.";
+        readonly name: "Job `name`, or the job key when no name is set.";
+    };
+}, {
+    readonly root: "executions";
+    readonly summary: "Every execution of the current job.";
+    readonly propertyPrefix: "executions[*].";
+    readonly fields: {
+        readonly index: "Position of the execution in its job, starting at zero.";
+        readonly name: "Resolved execution name, or the job name when `execution_name` is not set.";
+        readonly status: "Final status of the execution.";
+        readonly started_at: "Time the execution started.";
+        readonly finished_at: "Time the execution finished.";
+        readonly events: "Listener events in the batch that started this execution. Empty for a standard job.";
+        readonly 'events[*].source': "Integration connection slug that delivered the event.";
+        readonly 'events[*].event': "Shipfox event name.";
+        readonly 'events[*].delivery_id': "Identifier of the provider delivery.";
+        readonly 'events[*].received_at': "Time Shipfox received the event.";
+        readonly 'events[*].project': "Shipfox project resolved from the event repository. Null when there is none.";
+        readonly 'events[*].project.id': "Identifier of the resolved project.";
+        readonly 'events[*].repository': "Repository the event came from, as `owner/name`. Null when there is none.";
+        readonly 'events[*].ref': "Git ref the event carried. Null when there is none.";
+        readonly 'events[*].commit': "Commit SHA the event carried. Null when there is none.";
+        readonly 'events[*].data': "Raw event payload. The provider owns its shape.";
+        readonly outputs: "Outputs the execution produced, keyed by output name.";
+    };
+}, {
+    readonly root: "execution";
+    readonly summary: "The current execution of the job.";
+    readonly fields: {
+        readonly failed: "Whether an earlier step in this execution failed.";
+        readonly index: "Position of the execution in its job, starting at zero.";
+        readonly name: "Resolved execution name, or the job name when `execution_name` is not set.";
+        readonly status: "Final status of the execution.";
+        readonly started_at: "Time the execution started.";
+        readonly finished_at: "Time the execution finished.";
+        readonly events: "Listener events in the batch that started this execution. Empty for a standard job.";
+        readonly 'events[*].source': "Integration connection slug that delivered the event.";
+        readonly 'events[*].event': "Shipfox event name.";
+        readonly 'events[*].delivery_id': "Identifier of the provider delivery.";
+        readonly 'events[*].received_at': "Time Shipfox received the event.";
+        readonly 'events[*].project': "Shipfox project resolved from the event repository. Null when there is none.";
+        readonly 'events[*].project.id': "Identifier of the resolved project.";
+        readonly 'events[*].repository': "Repository the event came from, as `owner/name`. Null when there is none.";
+        readonly 'events[*].ref': "Git ref the event carried. Null when there is none.";
+        readonly 'events[*].commit': "Commit SHA the event carried. Null when there is none.";
+        readonly 'events[*].data': "Raw event payload. The provider owns its shape.";
+        readonly outputs: "Outputs the execution produced, keyed by output name.";
+    };
+}, {
+    readonly root: "jobs";
+    readonly summary: "Upstream jobs, keyed by job key.";
+    readonly shapeNote: "The keys are the job keys the workflow declares.";
+    readonly propertyPrefix: "jobs.<job_key>.";
+    readonly fields: {
+        readonly key: "Key of the job in the `jobs` map.";
+        readonly status: "Final status of the job.";
+        readonly outputs: "Declared job outputs, keyed by output name.";
+        readonly executions: "Executions of the job, each with the properties of the `execution` context. A standard job has one.";
+    };
+    readonly collapse: readonly ["executions"];
+}, {
+    readonly root: "needs";
+    readonly summary: "The jobs this job declares in `needs`.";
+    readonly propertyPrefix: "needs[*].";
+    readonly fields: {
+        readonly key: "Key of the job in the `jobs` map.";
+        readonly status: "Final status of the job.";
+        readonly outputs: "Declared job outputs, keyed by output name.";
+        readonly executions: "Executions of the job, each with the properties of the `execution` context. A standard job has one.";
+    };
+    readonly collapse: readonly ["executions"];
+}, {
+    readonly root: "steps";
+    readonly summary: "Earlier steps of the current job, keyed by step key.";
+    readonly shapeNote: "The keys are the step keys the workflow declares.";
+    readonly propertyPrefix: "steps.<step_key>.";
+    readonly fields: {
+        readonly status: "Final status of the step.";
+        readonly exit_code: "Exit code of the most recent finished attempt.";
+        readonly outputs: "Declared step outputs of the most recent finished attempt.";
+        readonly response: "Final agent response. Absent on a run step.";
+        readonly gate: "Gate result of the most recent finished attempt. Absent when the step has no gate.";
+        readonly 'gate.passed': "Whether the gate expression passed.";
+        readonly 'gate.source': "Gate expression that produced the result.";
+        readonly 'gate.reason': "Why Shipfox could not check the gate.";
+        readonly 'gate.exit_code': "Exit code the gate read.";
+        readonly attempts: "Every finished attempt of the step, oldest first.";
+        readonly 'attempts[*].status': "Final status of the attempt.";
+        readonly 'attempts[*].exit_code': "Exit code the attempt reported.";
+        readonly 'attempts[*].outputs': "Declared outputs the attempt reported.";
+        readonly 'attempts[*].response': "Final agent response of the attempt. Absent on a run step.";
+        readonly 'attempts[*].gate': "Gate result of the attempt. Absent when the step has no gate.";
+        readonly 'attempts[*].gate.passed': "Whether the gate expression passed.";
+        readonly 'attempts[*].gate.source': "Gate expression that produced the result.";
+        readonly 'attempts[*].gate.reason': "Why Shipfox could not check the gate.";
+        readonly 'attempts[*].gate.exit_code': "Exit code the gate read.";
+    };
+}, {
+    readonly root: "step";
+    readonly summary: "The current step. Its properties depend on the field that reads it.";
+    readonly fields: {
+        readonly attempt: "Attempt number of the step, starting at one. Not readable in `gate.success`.";
+        readonly is_retry: "Whether this is a repeat attempt. Not readable in `gate.success`.";
+        readonly restart: "Set when a gate restarted this step. Not readable in `gate.success`.";
+        readonly 'restart.from': "The step whose gate restarted this attempt, with the properties of a `steps` entry. Not readable in `gate.success`.";
+        readonly 'restart.feedback': "Feedback the restarting gate produced. Not readable in `gate.success`.";
+        readonly exit_code: "Exit code the step reported. Readable in `gate.success` only.";
+        readonly status: "Status the step reported. Readable in `gate.success` only.";
+        readonly outputs: "Outputs the step reported. Readable in `gate.success` only.";
+    };
+    readonly collapse: readonly ["restart.from"];
+}, {
+    readonly root: "vars";
+    readonly summary: "Workspace and project variables.";
+    readonly shapeNote: "The keys are the variable names the workspace defines. See [Secrets and variables](/reference/secrets-variables).";
+}, {
+    readonly root: "secrets";
+    readonly summary: "Workspace and project secrets.";
+    readonly shapeNote: "The keys are the secret names the workspace defines. See [Secrets and variables](/reference/secrets-variables).";
+}];
+//# sourceMappingURL=workflow-context-docs.d.ts.map

package/dist/workflow-context/workflow-context-docs.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"workflow-context-docs.d.ts","sourceRoot":"","sources":["../../src/workflow-context/workflow-context-docs.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAC,mBAAmB,EAAC,MAAM,uBAAuB,CAAC;AAE/D;;;;;;;GAOG;AACH,MAAM,WAAW,kBAAkB;IACjC,QAAQ,CAAC,IAAI,EAAE,mBAAmB,CAAC;IACnC,QAAQ,CAAC,OAAO,EAAE,MAAM,CAAC;IACzB,oDAAoD;IACpD,QAAQ,CAAC,SAAS,CAAC,EAAE,MAAM,CAAC;IAC5B,gEAAgE;IAChE,QAAQ,CAAC,cAAc,CAAC,EAAE,MAAM,CAAC;IACjC,2DAA2D;IAC3D,QAAQ,CAAC,MAAM,CAAC,EAAE,QAAQ,CAAC,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC,CAAC;IACnD,gEAAgE;IAChE,QAAQ,CAAC,QAAQ,CAAC,EAAE,SAAS,MAAM,EAAE,CAAC;CACvC;AAsDD,eAAO,MAAM,mBAAmB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EAsHkB,CAAC"}

package/dist/workflow-context/workflow-context-docs.js

@@ -0,0 +1,168 @@
+const executionFields = {
+    index: 'Position of the execution in its job, starting at zero.',
+    name: 'Resolved execution name, or the job name when `execution_name` is not set.',
+    status: 'Final status of the execution.',
+    started_at: 'Time the execution started.',
+    finished_at: 'Time the execution finished.',
+    events: 'Listener events in the batch that started this execution. Empty for a standard job.',
+    'events[*].source': 'Integration connection slug that delivered the event.',
+    'events[*].event': 'Shipfox event name.',
+    'events[*].delivery_id': 'Identifier of the provider delivery.',
+    'events[*].received_at': 'Time Shipfox received the event.',
+    'events[*].project': 'Shipfox project resolved from the event repository. Null when there is none.',
+    'events[*].project.id': 'Identifier of the resolved project.',
+    'events[*].repository': 'Repository the event came from, as `owner/name`. Null when there is none.',
+    'events[*].ref': 'Git ref the event carried. Null when there is none.',
+    'events[*].commit': 'Commit SHA the event carried. Null when there is none.',
+    'events[*].data': 'Raw event payload. The provider owns its shape.',
+    outputs: 'Outputs the execution produced, keyed by output name.'
+};
+const jobEntityFields = {
+    key: 'Key of the job in the `jobs` map.',
+    status: 'Final status of the job.',
+    outputs: 'Declared job outputs, keyed by output name.',
+    executions: 'Executions of the job, each with the properties of the `execution` context. A standard job has one.'
+};
+const stepEntityFields = {
+    status: 'Final status of the step.',
+    exit_code: 'Exit code of the most recent finished attempt.',
+    outputs: 'Declared step outputs of the most recent finished attempt.',
+    response: 'Final agent response. Absent on a run step.',
+    gate: 'Gate result of the most recent finished attempt. Absent when the step has no gate.',
+    'gate.passed': 'Whether the gate expression passed.',
+    'gate.source': 'Gate expression that produced the result.',
+    'gate.reason': 'Why Shipfox could not check the gate.',
+    'gate.exit_code': 'Exit code the gate read.',
+    attempts: 'Every finished attempt of the step, oldest first.',
+    'attempts[*].status': 'Final status of the attempt.',
+    'attempts[*].exit_code': 'Exit code the attempt reported.',
+    'attempts[*].outputs': 'Declared outputs the attempt reported.',
+    'attempts[*].response': 'Final agent response of the attempt. Absent on a run step.',
+    'attempts[*].gate': 'Gate result of the attempt. Absent when the step has no gate.',
+    'attempts[*].gate.passed': 'Whether the gate expression passed.',
+    'attempts[*].gate.source': 'Gate expression that produced the result.',
+    'attempts[*].gate.reason': 'Why Shipfox could not check the gate.',
+    'attempts[*].gate.exit_code': 'Exit code the gate read.'
+};
+export const workflowContextDocs = [
+    {
+        root: 'workflow',
+        summary: 'The workflow definition this run came from.',
+        fields: {
+            id: 'Identifier of the workflow definition.',
+            name: 'Workflow `name` from the definition.'
+        }
+    },
+    {
+        root: 'run',
+        summary: 'The current run.',
+        fields: {
+            id: 'Identifier of the run.',
+            number: 'Sequential run number within the workflow definition.',
+            name: 'Resolved run name, or the workflow name when `run_name` is not set.',
+            project_id: 'Identifier of the project that owns the run.',
+            workspace_id: 'Identifier of the workspace that owns the run.',
+            created_at: 'Time the run was created.'
+        }
+    },
+    {
+        root: 'trigger',
+        summary: 'The trigger that started the run.',
+        fields: {
+            source: 'Integration connection slug, or `manual` or `cron`.',
+            event: 'Shipfox event name that matched the trigger.',
+            project: 'Shipfox project resolved from the event repository. Null when there is none.',
+            'project.id': 'Identifier of the resolved project.',
+            repository: 'Repository the event came from, as `owner/name`. Null when there is none.',
+            ref: 'Git ref the event carried. Null when there is none.',
+            commit: 'Commit SHA the event carried. Null when there is none.'
+        }
+    },
+    {
+        root: 'event',
+        summary: 'The raw payload of the event that started the run.',
+        shapeNote: 'The provider owns this payload, so it has no fixed shape. Each provider page under [Integrations](/integrations) lists the events Shipfox delivers and links the payload each one carries.'
+    },
+    {
+        root: 'inputs',
+        summary: 'Values the trigger `with` block passed into the run.',
+        shapeNote: 'The keys are the ones the trigger declares. See [trigger fields](/reference/workflow-schema#trigger-fields).'
+    },
+    {
+        root: 'job',
+        summary: 'The current job.',
+        fields: {
+            key: 'Key of the job in the `jobs` map.',
+            name: 'Job `name`, or the job key when no name is set.'
+        }
+    },
+    {
+        root: 'executions',
+        summary: 'Every execution of the current job.',
+        propertyPrefix: 'executions[*].',
+        fields: executionFields
+    },
+    {
+        root: 'execution',
+        summary: 'The current execution of the job.',
+        fields: {
+            ...executionFields,
+            failed: 'Whether an earlier step in this execution failed.'
+        }
+    },
+    {
+        root: 'jobs',
+        summary: 'Upstream jobs, keyed by job key.',
+        shapeNote: 'The keys are the job keys the workflow declares.',
+        propertyPrefix: 'jobs.<job_key>.',
+        fields: jobEntityFields,
+        collapse: [
+            'executions'
+        ]
+    },
+    {
+        root: 'needs',
+        summary: 'The jobs this job declares in `needs`.',
+        propertyPrefix: 'needs[*].',
+        fields: jobEntityFields,
+        collapse: [
+            'executions'
+        ]
+    },
+    {
+        root: 'steps',
+        summary: 'Earlier steps of the current job, keyed by step key.',
+        shapeNote: 'The keys are the step keys the workflow declares.',
+        propertyPrefix: 'steps.<step_key>.',
+        fields: stepEntityFields
+    },
+    {
+        root: 'step',
+        summary: 'The current step. Its properties depend on the field that reads it.',
+        fields: {
+            attempt: 'Attempt number of the step, starting at one. Not readable in `gate.success`.',
+            is_retry: 'Whether this is a repeat attempt. Not readable in `gate.success`.',
+            restart: 'Set when a gate restarted this step. Not readable in `gate.success`.',
+            'restart.from': 'The step whose gate restarted this attempt, with the properties of a `steps` entry. Not readable in `gate.success`.',
+            'restart.feedback': 'Feedback the restarting gate produced. Not readable in `gate.success`.',
+            exit_code: 'Exit code the step reported. Readable in `gate.success` only.',
+            status: 'Status the step reported. Readable in `gate.success` only.',
+            outputs: 'Outputs the step reported. Readable in `gate.success` only.'
+        },
+        collapse: [
+            'restart.from'
+        ]
+    },
+    {
+        root: 'vars',
+        summary: 'Workspace and project variables.',
+        shapeNote: 'The keys are the variable names the workspace defines. See [Secrets and variables](/reference/secrets-variables).'
+    },
+    {
+        root: 'secrets',
+        summary: 'Workspace and project secrets.',
+        shapeNote: 'The keys are the secret names the workspace defines. See [Secrets and variables](/reference/secrets-variables).'
+    }
+];
+
+//# sourceMappingURL=workflow-context-docs.js.map

package/dist/workflow-context/workflow-context-docs.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../../src/workflow-context/workflow-context-docs.ts"],"sourcesContent":["import type {WorkflowContextName} from './workflow-context.js';\n\n/**\n * Reader-facing descriptions for every context root and property.\n *\n * They live beside the type registry so a new field cannot ship undescribed:\n * the documentation generator renders types from the registry and looks up each\n * property here, and its check fails on a property with no description or a\n * description for a property that no longer exists.\n */\nexport interface WorkflowContextDoc {\n  readonly root: WorkflowContextName;\n  readonly summary: string;\n  /** Why an open-shape root has no property table. */\n  readonly shapeNote?: string;\n  /** Prefix shown in the property column, such as `needs[*].`. */\n  readonly propertyPrefix?: string;\n  /** Description per property path, relative to the root. */\n  readonly fields?: Readonly<Record<string, string>>;\n  /** Paths whose element shape another root already documents. */\n  readonly collapse?: readonly string[];\n}\n\nconst executionFields = {\n  index: 'Position of the execution in its job, starting at zero.',\n  name: 'Resolved execution name, or the job name when `execution_name` is not set.',\n  status: 'Final status of the execution.',\n  started_at: 'Time the execution started.',\n  finished_at: 'Time the execution finished.',\n  events: 'Listener events in the batch that started this execution. Empty for a standard job.',\n  'events[*].source': 'Integration connection slug that delivered the event.',\n  'events[*].event': 'Shipfox event name.',\n  'events[*].delivery_id': 'Identifier of the provider delivery.',\n  'events[*].received_at': 'Time Shipfox received the event.',\n  'events[*].project':\n    'Shipfox project resolved from the event repository. Null when there is none.',\n  'events[*].project.id': 'Identifier of the resolved project.',\n  'events[*].repository':\n    'Repository the event came from, as `owner/name`. Null when there is none.',\n  'events[*].ref': 'Git ref the event carried. Null when there is none.',\n  'events[*].commit': 'Commit SHA the event carried. Null when there is none.',\n  'events[*].data': 'Raw event payload. The provider owns its shape.',\n  outputs: 'Outputs the execution produced, keyed by output name.',\n} as const;\n\nconst jobEntityFields = {\n  key: 'Key of the job in the `jobs` map.',\n  status: 'Final status of the job.',\n  outputs: 'Declared job outputs, keyed by output name.',\n  executions:\n    'Executions of the job, each with the properties of the `execution` context. A standard job has one.',\n} as const;\n\nconst stepEntityFields = {\n  status: 'Final status of the step.',\n  exit_code: 'Exit code of the most recent finished attempt.',\n  outputs: 'Declared step outputs of the most recent finished attempt.',\n  response: 'Final agent response. Absent on a run step.',\n  gate: 'Gate result of the most recent finished attempt. Absent when the step has no gate.',\n  'gate.passed': 'Whether the gate expression passed.',\n  'gate.source': 'Gate expression that produced the result.',\n  'gate.reason': 'Why Shipfox could not check the gate.',\n  'gate.exit_code': 'Exit code the gate read.',\n  attempts: 'Every finished attempt of the step, oldest first.',\n  'attempts[*].status': 'Final status of the attempt.',\n  'attempts[*].exit_code': 'Exit code the attempt reported.',\n  'attempts[*].outputs': 'Declared outputs the attempt reported.',\n  'attempts[*].response': 'Final agent response of the attempt. Absent on a run step.',\n  'attempts[*].gate': 'Gate result of the attempt. Absent when the step has no gate.',\n  'attempts[*].gate.passed': 'Whether the gate expression passed.',\n  'attempts[*].gate.source': 'Gate expression that produced the result.',\n  'attempts[*].gate.reason': 'Why Shipfox could not check the gate.',\n  'attempts[*].gate.exit_code': 'Exit code the gate read.',\n} as const;\n\nexport const workflowContextDocs = [\n  {\n    root: 'workflow',\n    summary: 'The workflow definition this run came from.',\n    fields: {\n      id: 'Identifier of the workflow definition.',\n      name: 'Workflow `name` from the definition.',\n    },\n  },\n  {\n    root: 'run',\n    summary: 'The current run.',\n    fields: {\n      id: 'Identifier of the run.',\n      number: 'Sequential run number within the workflow definition.',\n      name: 'Resolved run name, or the workflow name when `run_name` is not set.',\n      project_id: 'Identifier of the project that owns the run.',\n      workspace_id: 'Identifier of the workspace that owns the run.',\n      created_at: 'Time the run was created.',\n    },\n  },\n  {\n    root: 'trigger',\n    summary: 'The trigger that started the run.',\n    fields: {\n      source: 'Integration connection slug, or `manual` or `cron`.',\n      event: 'Shipfox event name that matched the trigger.',\n      project: 'Shipfox project resolved from the event repository. Null when there is none.',\n      'project.id': 'Identifier of the resolved project.',\n      repository: 'Repository the event came from, as `owner/name`. Null when there is none.',\n      ref: 'Git ref the event carried. Null when there is none.',\n      commit: 'Commit SHA the event carried. Null when there is none.',\n    },\n  },\n  {\n    root: 'event',\n    summary: 'The raw payload of the event that started the run.',\n    shapeNote:\n      'The provider owns this payload, so it has no fixed shape. Each provider page under [Integrations](/integrations) lists the events Shipfox delivers and links the payload each one carries.',\n  },\n  {\n    root: 'inputs',\n    summary: 'Values the trigger `with` block passed into the run.',\n    shapeNote:\n      'The keys are the ones the trigger declares. See [trigger fields](/reference/workflow-schema#trigger-fields).',\n  },\n  {\n    root: 'job',\n    summary: 'The current job.',\n    fields: {\n      key: 'Key of the job in the `jobs` map.',\n      name: 'Job `name`, or the job key when no name is set.',\n    },\n  },\n  {\n    root: 'executions',\n    summary: 'Every execution of the current job.',\n    propertyPrefix: 'executions[*].',\n    fields: executionFields,\n  },\n  {\n    root: 'execution',\n    summary: 'The current execution of the job.',\n    fields: {\n      ...executionFields,\n      failed: 'Whether an earlier step in this execution failed.',\n    },\n  },\n  {\n    root: 'jobs',\n    summary: 'Upstream jobs, keyed by job key.',\n    shapeNote: 'The keys are the job keys the workflow declares.',\n    propertyPrefix: 'jobs.<job_key>.',\n    fields: jobEntityFields,\n    collapse: ['executions'],\n  },\n  {\n    root: 'needs',\n    summary: 'The jobs this job declares in `needs`.',\n    propertyPrefix: 'needs[*].',\n    fields: jobEntityFields,\n    collapse: ['executions'],\n  },\n  {\n    root: 'steps',\n    summary: 'Earlier steps of the current job, keyed by step key.',\n    shapeNote: 'The keys are the step keys the workflow declares.',\n    propertyPrefix: 'steps.<step_key>.',\n    fields: stepEntityFields,\n  },\n  {\n    root: 'step',\n    summary: 'The current step. Its properties depend on the field that reads it.',\n    fields: {\n      attempt: 'Attempt number of the step, starting at one. Not readable in `gate.success`.',\n      is_retry: 'Whether this is a repeat attempt. Not readable in `gate.success`.',\n      restart: 'Set when a gate restarted this step. Not readable in `gate.success`.',\n      'restart.from':\n        'The step whose gate restarted this attempt, with the properties of a `steps` entry. Not readable in `gate.success`.',\n      'restart.feedback': 'Feedback the restarting gate produced. Not readable in `gate.success`.',\n      exit_code: 'Exit code the step reported. Readable in `gate.success` only.',\n      status: 'Status the step reported. Readable in `gate.success` only.',\n      outputs: 'Outputs the step reported. Readable in `gate.success` only.',\n    },\n    collapse: ['restart.from'],\n  },\n  {\n    root: 'vars',\n    summary: 'Workspace and project variables.',\n    shapeNote:\n      'The keys are the variable names the workspace defines. See [Secrets and variables](/reference/secrets-variables).',\n  },\n  {\n    root: 'secrets',\n    summary: 'Workspace and project secrets.',\n    shapeNote:\n      'The keys are the secret names the workspace defines. See [Secrets and variables](/reference/secrets-variables).',\n  },\n] as const satisfies readonly WorkflowContextDoc[];\n"],"names":["executionFields","index","name","status","started_at","finished_at","events","outputs","jobEntityFields","key","executions","stepEntityFields","exit_code","response","gate","attempts","workflowContextDocs","root","summary","fields","id","number","project_id","workspace_id","created_at","source","event","project","repository","ref","commit","shapeNote","propertyPrefix","failed","collapse","attempt","is_retry","restart"],"mappings":"AAuBA,MAAMA,kBAAkB;IACtBC,OAAO;IACPC,MAAM;IACNC,QAAQ;IACRC,YAAY;IACZC,aAAa;IACbC,QAAQ;IACR,oBAAoB;IACpB,mBAAmB;IACnB,yBAAyB;IACzB,yBAAyB;IACzB,qBACE;IACF,wBAAwB;IACxB,wBACE;IACF,iBAAiB;IACjB,oBAAoB;IACpB,kBAAkB;IAClBC,SAAS;AACX;AAEA,MAAMC,kBAAkB;IACtBC,KAAK;IACLN,QAAQ;IACRI,SAAS;IACTG,YACE;AACJ;AAEA,MAAMC,mBAAmB;IACvBR,QAAQ;IACRS,WAAW;IACXL,SAAS;IACTM,UAAU;IACVC,MAAM;IACN,eAAe;IACf,eAAe;IACf,eAAe;IACf,kBAAkB;IAClBC,UAAU;IACV,sBAAsB;IACtB,yBAAyB;IACzB,uBAAuB;IACvB,wBAAwB;IACxB,oBAAoB;IACpB,2BAA2B;IAC3B,2BAA2B;IAC3B,2BAA2B;IAC3B,8BAA8B;AAChC;AAEA,OAAO,MAAMC,sBAAsB;IACjC;QACEC,MAAM;QACNC,SAAS;QACTC,QAAQ;YACNC,IAAI;YACJlB,MAAM;QACR;IACF;IACA;QACEe,MAAM;QACNC,SAAS;QACTC,QAAQ;YACNC,IAAI;YACJC,QAAQ;YACRnB,MAAM;YACNoB,YAAY;YACZC,cAAc;YACdC,YAAY;QACd;IACF;IACA;QACEP,MAAM;QACNC,SAAS;QACTC,QAAQ;YACNM,QAAQ;YACRC,OAAO;YACPC,SAAS;YACT,cAAc;YACdC,YAAY;YACZC,KAAK;YACLC,QAAQ;QACV;IACF;IACA;QACEb,MAAM;QACNC,SAAS;QACTa,WACE;IACJ;IACA;QACEd,MAAM;QACNC,SAAS;QACTa,WACE;IACJ;IACA;QACEd,MAAM;QACNC,SAAS;QACTC,QAAQ;YACNV,KAAK;YACLP,MAAM;QACR;IACF;IACA;QACEe,MAAM;QACNC,SAAS;QACTc,gBAAgB;QAChBb,QAAQnB;IACV;IACA;QACEiB,MAAM;QACNC,SAAS;QACTC,QAAQ;YACN,GAAGnB,eAAe;YAClBiC,QAAQ;QACV;IACF;IACA;QACEhB,MAAM;QACNC,SAAS;QACTa,WAAW;QACXC,gBAAgB;QAChBb,QAAQX;QACR0B,UAAU;YAAC;SAAa;IAC1B;IACA;QACEjB,MAAM;QACNC,SAAS;QACTc,gBAAgB;QAChBb,QAAQX;QACR0B,UAAU;YAAC;SAAa;IAC1B;IACA;QACEjB,MAAM;QACNC,SAAS;QACTa,WAAW;QACXC,gBAAgB;QAChBb,QAAQR;IACV;IACA;QACEM,MAAM;QACNC,SAAS;QACTC,QAAQ;YACNgB,SAAS;YACTC,UAAU;YACVC,SAAS;YACT,gBACE;YACF,oBAAoB;YACpBzB,WAAW;YACXT,QAAQ;YACRI,SAAS;QACX;QACA2B,UAAU;YAAC;SAAe;IAC5B;IACA;QACEjB,MAAM;QACNC,SAAS;QACTa,WACE;IACJ;IACA;QACEd,MAAM;QACNC,SAAS;QACTa,WACE;IACJ;CACD,CAAkD"}