@makeplane/plane-node-sdk 0.2.12 → 0.2.13
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 +4 -1
- package/dist/api/Pages.d.ts +47 -1
- package/dist/api/Pages.d.ts.map +1 -1
- package/dist/api/Pages.js +62 -0
- package/dist/api/Pages.js.map +1 -1
- package/dist/api/WorkItemTypeGovernance/Pins.d.ts +26 -0
- package/dist/api/WorkItemTypeGovernance/Pins.d.ts.map +1 -0
- package/dist/api/WorkItemTypeGovernance/Pins.js +38 -0
- package/dist/api/WorkItemTypeGovernance/Pins.js.map +1 -0
- package/dist/api/WorkItemTypeGovernance/ProjectWorkflows.d.ts +37 -0
- package/dist/api/WorkItemTypeGovernance/ProjectWorkflows.d.ts.map +1 -0
- package/dist/api/WorkItemTypeGovernance/ProjectWorkflows.js +56 -0
- package/dist/api/WorkItemTypeGovernance/ProjectWorkflows.js.map +1 -0
- package/dist/api/WorkItemTypeGovernance/index.d.ts +36 -0
- package/dist/api/WorkItemTypeGovernance/index.d.ts.map +1 -0
- package/dist/api/WorkItemTypeGovernance/index.js +50 -0
- package/dist/api/WorkItemTypeGovernance/index.js.map +1 -0
- package/dist/api/Workflows/Hooks.d.ts +34 -0
- package/dist/api/Workflows/Hooks.d.ts.map +1 -0
- package/dist/api/Workflows/Hooks.js +52 -0
- package/dist/api/Workflows/Hooks.js.map +1 -0
- package/dist/api/Workflows/States.d.ts +13 -1
- package/dist/api/Workflows/States.d.ts.map +1 -1
- package/dist/api/Workflows/States.js +20 -0
- package/dist/api/Workflows/States.js.map +1 -1
- package/dist/api/Workflows/Transitions.d.ts +4 -0
- package/dist/api/Workflows/Transitions.d.ts.map +1 -1
- package/dist/api/Workflows/Transitions.js +6 -0
- package/dist/api/Workflows/Transitions.js.map +1 -1
- package/dist/api/Workflows/index.d.ts +29 -2
- package/dist/api/Workflows/index.d.ts.map +1 -1
- package/dist/api/Workflows/index.js +34 -1
- package/dist/api/Workflows/index.js.map +1 -1
- package/dist/api/WorkspaceStates.d.ts +55 -0
- package/dist/api/WorkspaceStates.d.ts.map +1 -0
- package/dist/api/WorkspaceStates.js +73 -0
- package/dist/api/WorkspaceStates.js.map +1 -0
- package/dist/api/WorkspaceWorkflows/Hooks.d.ts +56 -0
- package/dist/api/WorkspaceWorkflows/Hooks.d.ts.map +1 -0
- package/dist/api/WorkspaceWorkflows/Hooks.js +65 -0
- package/dist/api/WorkspaceWorkflows/Hooks.js.map +1 -0
- package/dist/api/WorkspaceWorkflows/States.d.ts +34 -0
- package/dist/api/WorkspaceWorkflows/States.d.ts.map +1 -0
- package/dist/api/WorkspaceWorkflows/States.js +47 -0
- package/dist/api/WorkspaceWorkflows/States.js.map +1 -0
- package/dist/api/WorkspaceWorkflows/Transitions.d.ts +31 -0
- package/dist/api/WorkspaceWorkflows/Transitions.d.ts.map +1 -0
- package/dist/api/WorkspaceWorkflows/Transitions.js +46 -0
- package/dist/api/WorkspaceWorkflows/Transitions.js.map +1 -0
- package/dist/api/WorkspaceWorkflows/index.d.ts +67 -0
- package/dist/api/WorkspaceWorkflows/index.d.ts.map +1 -0
- package/dist/api/WorkspaceWorkflows/index.js +73 -0
- package/dist/api/WorkspaceWorkflows/index.js.map +1 -0
- package/dist/client/plane-client.d.ts +6 -0
- package/dist/client/plane-client.d.ts.map +1 -1
- package/dist/client/plane-client.js +6 -0
- package/dist/client/plane-client.js.map +1 -1
- package/dist/index.d.ts +9 -0
- package/dist/index.d.ts.map +1 -1
- package/dist/index.js +20 -2
- package/dist/index.js.map +1 -1
- package/dist/models/Page.d.ts +21 -0
- package/dist/models/Page.d.ts.map +1 -1
- package/dist/models/Project.d.ts +1 -0
- package/dist/models/Project.d.ts.map +1 -1
- package/dist/models/State.d.ts +31 -0
- package/dist/models/State.d.ts.map +1 -1
- package/dist/models/WorkItemTypeGovernance.d.ts +130 -0
- package/dist/models/WorkItemTypeGovernance.d.ts.map +1 -0
- package/dist/models/WorkItemTypeGovernance.js +3 -0
- package/dist/models/WorkItemTypeGovernance.js.map +1 -0
- package/dist/models/Workflow.d.ts +62 -0
- package/dist/models/Workflow.d.ts.map +1 -1
- package/dist/models/WorkspaceFeatures.d.ts +18 -7
- package/dist/models/WorkspaceFeatures.d.ts.map +1 -1
- package/dist/models/WorkspaceWorkflow.d.ts +145 -0
- package/dist/models/WorkspaceWorkflow.d.ts.map +1 -0
- package/dist/models/WorkspaceWorkflow.js +3 -0
- package/dist/models/WorkspaceWorkflow.js.map +1 -0
- package/dist/models/index.d.ts +2 -0
- package/dist/models/index.d.ts.map +1 -1
- package/dist/models/index.js +2 -0
- package/dist/models/index.js.map +1 -1
- package/dist/types.bundle.d.ts +835 -8
- package/package.json +1 -1
|
@@ -27,4 +27,66 @@ export interface WorkflowTransition extends BaseModel {
|
|
|
27
27
|
}
|
|
28
28
|
export type CreateWorkflowTransition = Required<Pick<WorkflowTransition, "state_id" | "transition_state_id">> & Partial<Pick<WorkflowTransition, "type" | "member_ids" | "pre_rules" | "post_rules">>;
|
|
29
29
|
export type UpdateWorkflowTransition = Partial<Pick<WorkflowTransition, "pre_rules" | "post_rules">>;
|
|
30
|
+
/**
|
|
31
|
+
* A state's membership row within a workflow chain. `id` is the membership
|
|
32
|
+
* row's ID and `state_id` the state's own — the inverse of
|
|
33
|
+
* `WorkspaceWorkflowState`, whose rows are keyed by state ID.
|
|
34
|
+
*/
|
|
35
|
+
export interface WorkflowState {
|
|
36
|
+
id?: string;
|
|
37
|
+
state_id?: string;
|
|
38
|
+
workflow_id?: string;
|
|
39
|
+
type?: string;
|
|
40
|
+
allow_issue_creation?: boolean;
|
|
41
|
+
is_default?: boolean;
|
|
42
|
+
created_at?: string;
|
|
43
|
+
updated_at?: string;
|
|
44
|
+
}
|
|
45
|
+
export type UpdateWorkflowState = Partial<Pick<WorkflowState, "type" | "allow_issue_creation" | "is_default">>;
|
|
46
|
+
/**
|
|
47
|
+
* One workflow activity/audit entry
|
|
48
|
+
*/
|
|
49
|
+
export interface WorkflowActivity {
|
|
50
|
+
id?: string;
|
|
51
|
+
verb?: string;
|
|
52
|
+
field?: string;
|
|
53
|
+
old_value?: unknown;
|
|
54
|
+
new_value?: unknown;
|
|
55
|
+
actor?: unknown;
|
|
56
|
+
created_at?: string;
|
|
57
|
+
}
|
|
58
|
+
/**
|
|
59
|
+
* Request model for approving or rejecting a work item's pending workflow
|
|
60
|
+
* transition
|
|
61
|
+
*/
|
|
62
|
+
export interface SubmitWorkItemApproval {
|
|
63
|
+
type: "approve" | "reject";
|
|
64
|
+
}
|
|
65
|
+
/**
|
|
66
|
+
* Response of a work item workflow approval: the state the item moved to
|
|
67
|
+
*/
|
|
68
|
+
export interface WorkItemApprovalResult {
|
|
69
|
+
state_id?: string;
|
|
70
|
+
}
|
|
71
|
+
/**
|
|
72
|
+
* A validation/action hook attached to a workflow transition.
|
|
73
|
+
* `config.secret` is masked for send_webhook handlers; the one-shot
|
|
74
|
+
* `secret_plaintext` appears on create and regenerate responses only.
|
|
75
|
+
*/
|
|
76
|
+
export interface WorkflowTransitionHook {
|
|
77
|
+
id?: string;
|
|
78
|
+
phase?: string;
|
|
79
|
+
handler_name?: string;
|
|
80
|
+
rule_type?: string;
|
|
81
|
+
execution_order?: number;
|
|
82
|
+
is_enabled?: boolean;
|
|
83
|
+
config?: Record<string, unknown>;
|
|
84
|
+
secret_plaintext?: string;
|
|
85
|
+
}
|
|
86
|
+
/**
|
|
87
|
+
* Request model for creating a workflow transition hook. `phase` and
|
|
88
|
+
* `handler_name` are immutable post-create.
|
|
89
|
+
*/
|
|
90
|
+
export type CreateWorkflowTransitionHook = Pick<WorkflowTransitionHook, "phase" | "handler_name" | "config"> & Partial<Pick<WorkflowTransitionHook, "is_enabled">>;
|
|
91
|
+
export type UpdateWorkflowTransitionHook = Partial<Pick<WorkflowTransitionHook, "config" | "is_enabled">>;
|
|
30
92
|
//# sourceMappingURL=Workflow.d.ts.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"Workflow.d.ts","sourceRoot":"","sources":["../../src/models/Workflow.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAE,MAAM,UAAU,CAAC;AAErC;;GAEG;AACH,MAAM,WAAW,QAAS,SAAQ,SAAS;IACzC,IAAI,EAAE,MAAM,CAAC;IACb,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,SAAS,CAAC,EAAE,OAAO,CAAC;IACpB,UAAU,CAAC,EAAE,OAAO,CAAC;IACrB,kBAAkB,CAAC,EAAE,MAAM,EAAE,CAAC;IAC9B,OAAO,EAAE,MAAM,CAAC;IAChB,SAAS,EAAE,MAAM,CAAC;CACnB;AAED,MAAM,MAAM,cAAc,GAAG,IAAI,CAAC,QAAQ,EAAE,MAAM,GAAG,aAAa,GAAG,WAAW,GAAG,oBAAoB,CAAC,CAAC;AAEzG,MAAM,MAAM,cAAc,GAAG,OAAO,CAAC,cAAc,CAAC,CAAC;AAErD,MAAM,WAAW,oBAAoB;IACnC,SAAS,EAAE,MAAM,EAAE,CAAC;CACrB;AAED,MAAM,WAAW,kBAAmB,SAAQ,SAAS;IACnD,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,mBAAmB,CAAC,EAAE,MAAM,CAAC;IAC7B,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,UAAU,CAAC,EAAE,MAAM,EAAE,CAAC;IACtB,SAAS,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,EAAE,CAAC;IACtC,UAAU,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,EAAE,CAAC;IACvC,iBAAiB,CAAC,EAAE,MAAM,CAAC;CAC5B;AAED,MAAM,MAAM,wBAAwB,GAAG,QAAQ,CAAC,IAAI,CAAC,kBAAkB,EAAE,UAAU,GAAG,qBAAqB,CAAC,CAAC,GAC3G,OAAO,CAAC,IAAI,CAAC,kBAAkB,EAAE,MAAM,GAAG,YAAY,GAAG,WAAW,GAAG,YAAY,CAAC,CAAC,CAAC;AAExF,MAAM,MAAM,wBAAwB,GAAG,OAAO,CAAC,IAAI,CAAC,kBAAkB,EAAE,WAAW,GAAG,YAAY,CAAC,CAAC,CAAC"}
|
|
1
|
+
{"version":3,"file":"Workflow.d.ts","sourceRoot":"","sources":["../../src/models/Workflow.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAE,MAAM,UAAU,CAAC;AAErC;;GAEG;AACH,MAAM,WAAW,QAAS,SAAQ,SAAS;IACzC,IAAI,EAAE,MAAM,CAAC;IACb,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,SAAS,CAAC,EAAE,OAAO,CAAC;IACpB,UAAU,CAAC,EAAE,OAAO,CAAC;IACrB,kBAAkB,CAAC,EAAE,MAAM,EAAE,CAAC;IAC9B,OAAO,EAAE,MAAM,CAAC;IAChB,SAAS,EAAE,MAAM,CAAC;CACnB;AAED,MAAM,MAAM,cAAc,GAAG,IAAI,CAAC,QAAQ,EAAE,MAAM,GAAG,aAAa,GAAG,WAAW,GAAG,oBAAoB,CAAC,CAAC;AAEzG,MAAM,MAAM,cAAc,GAAG,OAAO,CAAC,cAAc,CAAC,CAAC;AAErD,MAAM,WAAW,oBAAoB;IACnC,SAAS,EAAE,MAAM,EAAE,CAAC;CACrB;AAED,MAAM,WAAW,kBAAmB,SAAQ,SAAS;IACnD,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,mBAAmB,CAAC,EAAE,MAAM,CAAC;IAC7B,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,UAAU,CAAC,EAAE,MAAM,EAAE,CAAC;IACtB,SAAS,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,EAAE,CAAC;IACtC,UAAU,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,EAAE,CAAC;IACvC,iBAAiB,CAAC,EAAE,MAAM,CAAC;CAC5B;AAED,MAAM,MAAM,wBAAwB,GAAG,QAAQ,CAAC,IAAI,CAAC,kBAAkB,EAAE,UAAU,GAAG,qBAAqB,CAAC,CAAC,GAC3G,OAAO,CAAC,IAAI,CAAC,kBAAkB,EAAE,MAAM,GAAG,YAAY,GAAG,WAAW,GAAG,YAAY,CAAC,CAAC,CAAC;AAExF,MAAM,MAAM,wBAAwB,GAAG,OAAO,CAAC,IAAI,CAAC,kBAAkB,EAAE,WAAW,GAAG,YAAY,CAAC,CAAC,CAAC;AAErG;;;;GAIG;AACH,MAAM,WAAW,aAAa;IAC5B,EAAE,CAAC,EAAE,MAAM,CAAC;IACZ,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,oBAAoB,CAAC,EAAE,OAAO,CAAC;IAC/B,UAAU,CAAC,EAAE,OAAO,CAAC;IACrB,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,UAAU,CAAC,EAAE,MAAM,CAAC;CACrB;AAED,MAAM,MAAM,mBAAmB,GAAG,OAAO,CAAC,IAAI,CAAC,aAAa,EAAE,MAAM,GAAG,sBAAsB,GAAG,YAAY,CAAC,CAAC,CAAC;AAE/G;;GAEG;AACH,MAAM,WAAW,gBAAgB;IAC/B,EAAE,CAAC,EAAE,MAAM,CAAC;IACZ,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,SAAS,CAAC,EAAE,OAAO,CAAC;IACpB,SAAS,CAAC,EAAE,OAAO,CAAC;IACpB,KAAK,CAAC,EAAE,OAAO,CAAC;IAChB,UAAU,CAAC,EAAE,MAAM,CAAC;CACrB;AAED;;;GAGG;AACH,MAAM,WAAW,sBAAsB;IACrC,IAAI,EAAE,SAAS,GAAG,QAAQ,CAAC;CAC5B;AAED;;GAEG;AACH,MAAM,WAAW,sBAAsB;IACrC,QAAQ,CAAC,EAAE,MAAM,CAAC;CACnB;AAED;;;;GAIG;AACH,MAAM,WAAW,sBAAsB;IACrC,EAAE,CAAC,EAAE,MAAM,CAAC;IACZ,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,eAAe,CAAC,EAAE,MAAM,CAAC;IACzB,UAAU,CAAC,EAAE,OAAO,CAAC;IACrB,MAAM,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IACjC,gBAAgB,CAAC,EAAE,MAAM,CAAC;CAC3B;AAED;;;GAGG;AACH,MAAM,MAAM,4BAA4B,GAAG,IAAI,CAAC,sBAAsB,EAAE,OAAO,GAAG,cAAc,GAAG,QAAQ,CAAC,GAC1G,OAAO,CAAC,IAAI,CAAC,sBAAsB,EAAE,YAAY,CAAC,CAAC,CAAC;AAEtD,MAAM,MAAM,4BAA4B,GAAG,OAAO,CAAC,IAAI,CAAC,sBAAsB,EAAE,QAAQ,GAAG,YAAY,CAAC,CAAC,CAAC"}
|
|
@@ -1,13 +1,24 @@
|
|
|
1
1
|
/**
|
|
2
2
|
* Workspace Features model interfaces
|
|
3
|
+
*
|
|
4
|
+
* All fields are optional so a caller can toggle a single feature; the update
|
|
5
|
+
* endpoint is a partial (PATCH) that only applies the fields that are sent.
|
|
3
6
|
*/
|
|
4
7
|
export interface WorkspaceFeatures {
|
|
5
|
-
project_grouping
|
|
6
|
-
initiatives
|
|
7
|
-
teams
|
|
8
|
-
customers
|
|
9
|
-
wiki
|
|
10
|
-
pi
|
|
8
|
+
project_grouping?: boolean;
|
|
9
|
+
initiatives?: boolean;
|
|
10
|
+
teams?: boolean;
|
|
11
|
+
customers?: boolean;
|
|
12
|
+
wiki?: boolean;
|
|
13
|
+
pi?: boolean;
|
|
14
|
+
work_item_types?: boolean;
|
|
15
|
+
releases?: boolean;
|
|
16
|
+
/**
|
|
17
|
+
* Read-only: reports whether states and workflows live at the workspace
|
|
18
|
+
* level (workspace governance). Only the governance migration can change
|
|
19
|
+
* it — the update endpoint rejects it as an input.
|
|
20
|
+
*/
|
|
21
|
+
states_owned_by_workspace?: boolean;
|
|
11
22
|
}
|
|
12
|
-
export type UpdateWorkspaceFeatures = Partial<WorkspaceFeatures
|
|
23
|
+
export type UpdateWorkspaceFeatures = Partial<Omit<WorkspaceFeatures, "states_owned_by_workspace">>;
|
|
13
24
|
//# sourceMappingURL=WorkspaceFeatures.d.ts.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"WorkspaceFeatures.d.ts","sourceRoot":"","sources":["../../src/models/WorkspaceFeatures.ts"],"names":[],"mappings":"AAAA
|
|
1
|
+
{"version":3,"file":"WorkspaceFeatures.d.ts","sourceRoot":"","sources":["../../src/models/WorkspaceFeatures.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AACH,MAAM,WAAW,iBAAiB;IAChC,gBAAgB,CAAC,EAAE,OAAO,CAAC;IAC3B,WAAW,CAAC,EAAE,OAAO,CAAC;IACtB,KAAK,CAAC,EAAE,OAAO,CAAC;IAChB,SAAS,CAAC,EAAE,OAAO,CAAC;IACpB,IAAI,CAAC,EAAE,OAAO,CAAC;IACf,EAAE,CAAC,EAAE,OAAO,CAAC;IACb,eAAe,CAAC,EAAE,OAAO,CAAC;IAC1B,QAAQ,CAAC,EAAE,OAAO,CAAC;IACnB;;;;OAIG;IACH,yBAAyB,CAAC,EAAE,OAAO,CAAC;CACrC;AAED,MAAM,MAAM,uBAAuB,GAAG,OAAO,CAAC,IAAI,CAAC,iBAAiB,EAAE,2BAA2B,CAAC,CAAC,CAAC"}
|
|
@@ -0,0 +1,145 @@
|
|
|
1
|
+
import { PaginatedResponse } from "./common";
|
|
2
|
+
/**
|
|
3
|
+
* One state row in a workspace workflow's chain.
|
|
4
|
+
*
|
|
5
|
+
* Rows are keyed by catalog state IDs, so `id` is the state's own ID — the
|
|
6
|
+
* inverse of the project-scoped `WorkflowState` (see `./Workflow`), where
|
|
7
|
+
* `id` is the membership row's ID and `state_id` is the state's. The API
|
|
8
|
+
* never sends `state_id` on these rows; treat `id` as the state ID.
|
|
9
|
+
*
|
|
10
|
+
* `transitions` embeds the outgoing transitions (with approvers) when the
|
|
11
|
+
* payload is the full chain projection.
|
|
12
|
+
*/
|
|
13
|
+
export interface WorkspaceWorkflowState {
|
|
14
|
+
id?: string;
|
|
15
|
+
state_id?: string;
|
|
16
|
+
type?: string;
|
|
17
|
+
allow_issue_creation?: boolean;
|
|
18
|
+
is_default?: boolean;
|
|
19
|
+
sequence?: number;
|
|
20
|
+
transitions?: Record<string, unknown>[];
|
|
21
|
+
}
|
|
22
|
+
/**
|
|
23
|
+
* Workspace workflow model (catalog list row / detail superset).
|
|
24
|
+
*
|
|
25
|
+
* The list endpoint returns the count fields only; `retrieve` adds the full
|
|
26
|
+
* `states` chain, `project_ids`/`work_item_type_ids` usage, and
|
|
27
|
+
* `referenced_resources`.
|
|
28
|
+
*/
|
|
29
|
+
export interface WorkspaceWorkflow {
|
|
30
|
+
id?: string;
|
|
31
|
+
name: string;
|
|
32
|
+
description?: string;
|
|
33
|
+
is_default?: boolean;
|
|
34
|
+
is_active?: boolean;
|
|
35
|
+
workspace_id?: string;
|
|
36
|
+
project_id?: string;
|
|
37
|
+
states_count?: number;
|
|
38
|
+
projects_count?: number;
|
|
39
|
+
work_item_types_count?: number;
|
|
40
|
+
project_ids?: string[];
|
|
41
|
+
work_item_type_ids?: string[];
|
|
42
|
+
states?: WorkspaceWorkflowState[];
|
|
43
|
+
referenced_resources?: unknown;
|
|
44
|
+
created_at?: string;
|
|
45
|
+
updated_at?: string;
|
|
46
|
+
created_by?: string;
|
|
47
|
+
updated_by?: string;
|
|
48
|
+
}
|
|
49
|
+
export type PaginatedWorkspaceWorkflowResponse = PaginatedResponse<WorkspaceWorkflow>;
|
|
50
|
+
/**
|
|
51
|
+
* Request model for creating a workspace workflow (a draft until its chain
|
|
52
|
+
* is configured via the states endpoints)
|
|
53
|
+
*/
|
|
54
|
+
export type CreateWorkspaceWorkflow = {
|
|
55
|
+
name: string;
|
|
56
|
+
description?: string;
|
|
57
|
+
};
|
|
58
|
+
/**
|
|
59
|
+
* Request model for updating workspace workflow metadata
|
|
60
|
+
*/
|
|
61
|
+
export type UpdateWorkspaceWorkflow = Partial<{
|
|
62
|
+
name: string;
|
|
63
|
+
description: string;
|
|
64
|
+
is_active: boolean;
|
|
65
|
+
}>;
|
|
66
|
+
/**
|
|
67
|
+
* Request model for appending catalog states to a workflow's chain
|
|
68
|
+
*/
|
|
69
|
+
export interface AddWorkspaceWorkflowStates {
|
|
70
|
+
state_ids: string[];
|
|
71
|
+
}
|
|
72
|
+
/**
|
|
73
|
+
* Request model for updating a chain membership row.
|
|
74
|
+
* Changing `type` (e.g. to/from `approval`) removes the row's existing
|
|
75
|
+
* transitions server-side.
|
|
76
|
+
*/
|
|
77
|
+
export type UpdateWorkspaceWorkflowState = Partial<{
|
|
78
|
+
type: string;
|
|
79
|
+
allow_issue_creation: boolean;
|
|
80
|
+
is_default: boolean;
|
|
81
|
+
}>;
|
|
82
|
+
/**
|
|
83
|
+
* Request body for removing a state from a chain.
|
|
84
|
+
* Orphan-gated: every work item stranded by the removal must be covered by
|
|
85
|
+
* `state_mapping` (409 with an orphan report otherwise). Removing the default
|
|
86
|
+
* state requires `new_default_state_id`.
|
|
87
|
+
*/
|
|
88
|
+
export interface RemoveWorkspaceWorkflowState {
|
|
89
|
+
new_default_state_id?: string;
|
|
90
|
+
state_mapping?: Record<string, string>;
|
|
91
|
+
}
|
|
92
|
+
/**
|
|
93
|
+
* One project resolving to a workflow in the usage report
|
|
94
|
+
*/
|
|
95
|
+
export interface WorkspaceWorkflowUsageProject {
|
|
96
|
+
project_id?: string;
|
|
97
|
+
name?: string;
|
|
98
|
+
types: (string | null)[];
|
|
99
|
+
}
|
|
100
|
+
/**
|
|
101
|
+
* Usage report for a workspace workflow: projects/types resolving to it, plus
|
|
102
|
+
* the types mandating or allowing it
|
|
103
|
+
*/
|
|
104
|
+
export interface WorkspaceWorkflowUsage {
|
|
105
|
+
projects: WorkspaceWorkflowUsageProject[];
|
|
106
|
+
types_mandating: string[];
|
|
107
|
+
types_allowing: string[];
|
|
108
|
+
}
|
|
109
|
+
/**
|
|
110
|
+
* State transition within a workspace workflow
|
|
111
|
+
*/
|
|
112
|
+
export interface WorkspaceWorkflowTransition {
|
|
113
|
+
id?: string;
|
|
114
|
+
workflow_state_id?: string;
|
|
115
|
+
transition_state_id?: string;
|
|
116
|
+
rejection_state_id?: string;
|
|
117
|
+
required_approvals?: number;
|
|
118
|
+
member_ids?: string[];
|
|
119
|
+
pre_hooks?: Record<string, unknown>[];
|
|
120
|
+
post_hooks?: Record<string, unknown>[];
|
|
121
|
+
created_at?: string;
|
|
122
|
+
updated_at?: string;
|
|
123
|
+
}
|
|
124
|
+
/**
|
|
125
|
+
* Request model for creating a workspace workflow transition.
|
|
126
|
+
* `state_id` is the chain state the transition starts from; `member_ids` are
|
|
127
|
+
* the approvers (approval-type states only).
|
|
128
|
+
*/
|
|
129
|
+
export type CreateWorkspaceWorkflowTransition = {
|
|
130
|
+
state_id: string;
|
|
131
|
+
transition_state_id: string;
|
|
132
|
+
rejection_state_id?: string;
|
|
133
|
+
required_approvals?: number;
|
|
134
|
+
member_ids?: string[];
|
|
135
|
+
};
|
|
136
|
+
/**
|
|
137
|
+
* Request model for updating a workspace workflow transition
|
|
138
|
+
*/
|
|
139
|
+
export type UpdateWorkspaceWorkflowTransition = Partial<{
|
|
140
|
+
transition_state_id: string;
|
|
141
|
+
rejection_state_id: string;
|
|
142
|
+
required_approvals: number;
|
|
143
|
+
member_ids: string[];
|
|
144
|
+
}>;
|
|
145
|
+
//# sourceMappingURL=WorkspaceWorkflow.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"WorkspaceWorkflow.d.ts","sourceRoot":"","sources":["../../src/models/WorkspaceWorkflow.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,iBAAiB,EAAE,MAAM,UAAU,CAAC;AAE7C;;;;;;;;;;GAUG;AACH,MAAM,WAAW,sBAAsB;IACrC,EAAE,CAAC,EAAE,MAAM,CAAC;IACZ,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,oBAAoB,CAAC,EAAE,OAAO,CAAC;IAC/B,UAAU,CAAC,EAAE,OAAO,CAAC;IACrB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,WAAW,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,EAAE,CAAC;CACzC;AAED;;;;;;GAMG;AACH,MAAM,WAAW,iBAAiB;IAChC,EAAE,CAAC,EAAE,MAAM,CAAC;IACZ,IAAI,EAAE,MAAM,CAAC;IACb,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,UAAU,CAAC,EAAE,OAAO,CAAC;IACrB,SAAS,CAAC,EAAE,OAAO,CAAC;IACpB,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,cAAc,CAAC,EAAE,MAAM,CAAC;IACxB,qBAAqB,CAAC,EAAE,MAAM,CAAC;IAC/B,WAAW,CAAC,EAAE,MAAM,EAAE,CAAC;IACvB,kBAAkB,CAAC,EAAE,MAAM,EAAE,CAAC;IAC9B,MAAM,CAAC,EAAE,sBAAsB,EAAE,CAAC;IAClC,oBAAoB,CAAC,EAAE,OAAO,CAAC;IAC/B,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,UAAU,CAAC,EAAE,MAAM,CAAC;CACrB;AAED,MAAM,MAAM,kCAAkC,GAAG,iBAAiB,CAAC,iBAAiB,CAAC,CAAC;AAEtF;;;GAGG;AACH,MAAM,MAAM,uBAAuB,GAAG;IACpC,IAAI,EAAE,MAAM,CAAC;IACb,WAAW,CAAC,EAAE,MAAM,CAAC;CACtB,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,uBAAuB,GAAG,OAAO,CAAC;IAC5C,IAAI,EAAE,MAAM,CAAC;IACb,WAAW,EAAE,MAAM,CAAC;IACpB,SAAS,EAAE,OAAO,CAAC;CACpB,CAAC,CAAC;AAEH;;GAEG;AACH,MAAM,WAAW,0BAA0B;IACzC,SAAS,EAAE,MAAM,EAAE,CAAC;CACrB;AAED;;;;GAIG;AACH,MAAM,MAAM,4BAA4B,GAAG,OAAO,CAAC;IACjD,IAAI,EAAE,MAAM,CAAC;IACb,oBAAoB,EAAE,OAAO,CAAC;IAC9B,UAAU,EAAE,OAAO,CAAC;CACrB,CAAC,CAAC;AAEH;;;;;GAKG;AACH,MAAM,WAAW,4BAA4B;IAC3C,oBAAoB,CAAC,EAAE,MAAM,CAAC;IAC9B,aAAa,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;CACxC;AAED;;GAEG;AACH,MAAM,WAAW,6BAA6B;IAC5C,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,KAAK,EAAE,CAAC,MAAM,GAAG,IAAI,CAAC,EAAE,CAAC;CAC1B;AAED;;;GAGG;AACH,MAAM,WAAW,sBAAsB;IACrC,QAAQ,EAAE,6BAA6B,EAAE,CAAC;IAC1C,eAAe,EAAE,MAAM,EAAE,CAAC;IAC1B,cAAc,EAAE,MAAM,EAAE,CAAC;CAC1B;AAED;;GAEG;AACH,MAAM,WAAW,2BAA2B;IAC1C,EAAE,CAAC,EAAE,MAAM,CAAC;IACZ,iBAAiB,CAAC,EAAE,MAAM,CAAC;IAC3B,mBAAmB,CAAC,EAAE,MAAM,CAAC;IAC7B,kBAAkB,CAAC,EAAE,MAAM,CAAC;IAC5B,kBAAkB,CAAC,EAAE,MAAM,CAAC;IAC5B,UAAU,CAAC,EAAE,MAAM,EAAE,CAAC;IACtB,SAAS,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,EAAE,CAAC;IACtC,UAAU,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,EAAE,CAAC;IACvC,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,UAAU,CAAC,EAAE,MAAM,CAAC;CACrB;AAED;;;;GAIG;AACH,MAAM,MAAM,iCAAiC,GAAG;IAC9C,QAAQ,EAAE,MAAM,CAAC;IACjB,mBAAmB,EAAE,MAAM,CAAC;IAC5B,kBAAkB,CAAC,EAAE,MAAM,CAAC;IAC5B,kBAAkB,CAAC,EAAE,MAAM,CAAC;IAC5B,UAAU,CAAC,EAAE,MAAM,EAAE,CAAC;CACvB,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,iCAAiC,GAAG,OAAO,CAAC;IACtD,mBAAmB,EAAE,MAAM,CAAC;IAC5B,kBAAkB,EAAE,MAAM,CAAC;IAC3B,kBAAkB,EAAE,MAAM,CAAC;IAC3B,UAAU,EAAE,MAAM,EAAE,CAAC;CACtB,CAAC,CAAC"}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"WorkspaceWorkflow.js","sourceRoot":"","sources":["../../src/models/WorkspaceWorkflow.ts"],"names":[],"mappings":""}
|
package/dist/models/index.d.ts
CHANGED
|
@@ -38,4 +38,6 @@ export * from "./WorkItemRelationDefinition";
|
|
|
38
38
|
export * from "./Release";
|
|
39
39
|
export * from "./Workflow";
|
|
40
40
|
export * from "./ProjectTemplate";
|
|
41
|
+
export * from "./WorkspaceWorkflow";
|
|
42
|
+
export * from "./WorkItemTypeGovernance";
|
|
41
43
|
//# sourceMappingURL=index.d.ts.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/models/index.ts"],"names":[],"mappings":"AAAA,cAAc,YAAY,CAAC;AAC3B,cAAc,cAAc,CAAC;AAC7B,cAAc,cAAc,CAAC;AAC7B,cAAc,WAAW,CAAC;AAC1B,cAAc,UAAU,CAAC;AACzB,cAAc,YAAY,CAAC;AAC3B,cAAc,SAAS,CAAC;AACxB,cAAc,QAAQ,CAAC;AACvB,cAAc,YAAY,CAAC;AAC3B,cAAc,cAAc,CAAC;AAC7B,cAAc,mBAAmB,CAAC;AAClC,cAAc,UAAU,CAAC;AACzB,cAAc,SAAS,CAAC;AACxB,cAAc,QAAQ,CAAC;AACvB,cAAc,UAAU,CAAC;AACzB,cAAc,aAAa,CAAC;AAC5B,cAAc,UAAU,CAAC;AACzB,cAAc,SAAS,CAAC;AACxB,cAAc,QAAQ,CAAC;AACvB,cAAc,WAAW,CAAC;AAC1B,cAAc,QAAQ,CAAC;AACvB,cAAc,mBAAmB,CAAC;AAClC,cAAc,SAAS,CAAC;AACxB,cAAc,UAAU,CAAC;AACzB,cAAc,aAAa,CAAC;AAC5B,cAAc,QAAQ,CAAC;AACvB,cAAc,YAAY,CAAC;AAC3B,cAAc,oBAAoB,CAAC;AACnC,cAAc,gBAAgB,CAAC;AAC/B,cAAc,oBAAoB,CAAC;AACnC,cAAc,gBAAgB,CAAC;AAC/B,cAAc,WAAW,CAAC;AAC1B,cAAc,qBAAqB,CAAC;AACpC,cAAc,qBAAqB,CAAC;AACpC,cAAc,yBAAyB,CAAC;AACxC,cAAc,yBAAyB,CAAC;AACxC,cAAc,8BAA8B,CAAC;AAC7C,cAAc,WAAW,CAAC;AAC1B,cAAc,YAAY,CAAC;AAC3B,cAAc,mBAAmB,CAAC"}
|
|
1
|
+
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/models/index.ts"],"names":[],"mappings":"AAAA,cAAc,YAAY,CAAC;AAC3B,cAAc,cAAc,CAAC;AAC7B,cAAc,cAAc,CAAC;AAC7B,cAAc,WAAW,CAAC;AAC1B,cAAc,UAAU,CAAC;AACzB,cAAc,YAAY,CAAC;AAC3B,cAAc,SAAS,CAAC;AACxB,cAAc,QAAQ,CAAC;AACvB,cAAc,YAAY,CAAC;AAC3B,cAAc,cAAc,CAAC;AAC7B,cAAc,mBAAmB,CAAC;AAClC,cAAc,UAAU,CAAC;AACzB,cAAc,SAAS,CAAC;AACxB,cAAc,QAAQ,CAAC;AACvB,cAAc,UAAU,CAAC;AACzB,cAAc,aAAa,CAAC;AAC5B,cAAc,UAAU,CAAC;AACzB,cAAc,SAAS,CAAC;AACxB,cAAc,QAAQ,CAAC;AACvB,cAAc,WAAW,CAAC;AAC1B,cAAc,QAAQ,CAAC;AACvB,cAAc,mBAAmB,CAAC;AAClC,cAAc,SAAS,CAAC;AACxB,cAAc,UAAU,CAAC;AACzB,cAAc,aAAa,CAAC;AAC5B,cAAc,QAAQ,CAAC;AACvB,cAAc,YAAY,CAAC;AAC3B,cAAc,oBAAoB,CAAC;AACnC,cAAc,gBAAgB,CAAC;AAC/B,cAAc,oBAAoB,CAAC;AACnC,cAAc,gBAAgB,CAAC;AAC/B,cAAc,WAAW,CAAC;AAC1B,cAAc,qBAAqB,CAAC;AACpC,cAAc,qBAAqB,CAAC;AACpC,cAAc,yBAAyB,CAAC;AACxC,cAAc,yBAAyB,CAAC;AACxC,cAAc,8BAA8B,CAAC;AAC7C,cAAc,WAAW,CAAC;AAC1B,cAAc,YAAY,CAAC;AAC3B,cAAc,mBAAmB,CAAC;AAClC,cAAc,qBAAqB,CAAC;AACpC,cAAc,0BAA0B,CAAC"}
|
package/dist/models/index.js
CHANGED
|
@@ -54,4 +54,6 @@ __exportStar(require("./WorkItemRelationDefinition"), exports);
|
|
|
54
54
|
__exportStar(require("./Release"), exports);
|
|
55
55
|
__exportStar(require("./Workflow"), exports);
|
|
56
56
|
__exportStar(require("./ProjectTemplate"), exports);
|
|
57
|
+
__exportStar(require("./WorkspaceWorkflow"), exports);
|
|
58
|
+
__exportStar(require("./WorkItemTypeGovernance"), exports);
|
|
57
59
|
//# sourceMappingURL=index.js.map
|
package/dist/models/index.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/models/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,6CAA2B;AAC3B,+CAA6B;AAC7B,+CAA6B;AAC7B,4CAA0B;AAC1B,2CAAyB;AACzB,6CAA2B;AAC3B,0CAAwB;AACxB,yCAAuB;AACvB,6CAA2B;AAC3B,+CAA6B;AAC7B,oDAAkC;AAClC,2CAAyB;AACzB,0CAAwB;AACxB,yCAAuB;AACvB,2CAAyB;AACzB,8CAA4B;AAC5B,2CAAyB;AACzB,0CAAwB;AACxB,yCAAuB;AACvB,4CAA0B;AAC1B,yCAAuB;AACvB,oDAAkC;AAClC,0CAAwB;AACxB,2CAAyB;AACzB,8CAA4B;AAC5B,yCAAuB;AACvB,6CAA2B;AAC3B,qDAAmC;AACnC,iDAA+B;AAC/B,qDAAmC;AACnC,iDAA+B;AAC/B,4CAA0B;AAC1B,sDAAoC;AACpC,sDAAoC;AACpC,0DAAwC;AACxC,0DAAwC;AACxC,+DAA6C;AAC7C,4CAA0B;AAC1B,6CAA2B;AAC3B,oDAAkC"}
|
|
1
|
+
{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/models/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,6CAA2B;AAC3B,+CAA6B;AAC7B,+CAA6B;AAC7B,4CAA0B;AAC1B,2CAAyB;AACzB,6CAA2B;AAC3B,0CAAwB;AACxB,yCAAuB;AACvB,6CAA2B;AAC3B,+CAA6B;AAC7B,oDAAkC;AAClC,2CAAyB;AACzB,0CAAwB;AACxB,yCAAuB;AACvB,2CAAyB;AACzB,8CAA4B;AAC5B,2CAAyB;AACzB,0CAAwB;AACxB,yCAAuB;AACvB,4CAA0B;AAC1B,yCAAuB;AACvB,oDAAkC;AAClC,0CAAwB;AACxB,2CAAyB;AACzB,8CAA4B;AAC5B,yCAAuB;AACvB,6CAA2B;AAC3B,qDAAmC;AACnC,iDAA+B;AAC/B,qDAAmC;AACnC,iDAA+B;AAC/B,4CAA0B;AAC1B,sDAAoC;AACpC,sDAAoC;AACpC,0DAAwC;AACxC,0DAAwC;AACxC,+DAA6C;AAC7C,4CAA0B;AAC1B,6CAA2B;AAC3B,oDAAkC;AAClC,sDAAoC;AACpC,2DAAyC"}
|