@crvouga/mockingbird-service-plane 2.1.0 → 2.2.0
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/CHANGELOG.md +12 -4
- package/README.md +18 -1
- package/SUPPORT.md +8 -3
- package/dist/{chunk-4RCG3YYZ.js → chunk-EQQXMBQ4.js} +2 -2
- package/dist/{chunk-NSDJM2TL.js → chunk-ZF6D32HZ.js} +317 -14
- package/dist/chunk-ZF6D32HZ.js.map +7 -0
- package/dist/cli.js +2 -2
- package/dist/index.d.ts +66 -6
- package/dist/index.js +1 -1
- package/dist/server.d.ts +61 -1
- package/dist/server.js +2 -2
- package/openapi.yaml +445 -1
- package/package.json +1 -1
- package/dist/chunk-NSDJM2TL.js.map +0 -7
- /package/dist/{chunk-4RCG3YYZ.js.map → chunk-EQQXMBQ4.js.map} +0 -0
package/dist/cli.js
CHANGED
package/dist/index.d.ts
CHANGED
|
@@ -715,6 +715,8 @@ type PlaneWorkItemRecord = {
|
|
|
715
715
|
description_stripped: string | null;
|
|
716
716
|
priority: "urgent" | "high" | "medium" | "low" | "none";
|
|
717
717
|
state: string;
|
|
718
|
+
type_id: string | null;
|
|
719
|
+
type: string | null;
|
|
718
720
|
labels: string[];
|
|
719
721
|
assignees: string[];
|
|
720
722
|
parent: string | null;
|
|
@@ -754,6 +756,52 @@ type PlaneLinkRecord = {
|
|
|
754
756
|
created_at: string;
|
|
755
757
|
updated_at: string;
|
|
756
758
|
};
|
|
759
|
+
type PlaneCycleRecord = {
|
|
760
|
+
id: string;
|
|
761
|
+
name: string;
|
|
762
|
+
description: string;
|
|
763
|
+
start_date: string | null;
|
|
764
|
+
end_date: string | null;
|
|
765
|
+
owned_by: string | null;
|
|
766
|
+
timezone: string;
|
|
767
|
+
external_source: string | null;
|
|
768
|
+
external_id: string | null;
|
|
769
|
+
project: string;
|
|
770
|
+
workspace: string;
|
|
771
|
+
created_at: string;
|
|
772
|
+
updated_at: string;
|
|
773
|
+
archived_at: string | null;
|
|
774
|
+
deleted_at: string | null;
|
|
775
|
+
};
|
|
776
|
+
type PlaneCycleMembership = {
|
|
777
|
+
id: string;
|
|
778
|
+
cycle: string;
|
|
779
|
+
issue: string;
|
|
780
|
+
project: string;
|
|
781
|
+
workspace: string;
|
|
782
|
+
created_at: string;
|
|
783
|
+
updated_at: string;
|
|
784
|
+
deleted_at: string | null;
|
|
785
|
+
};
|
|
786
|
+
type PlaneWorkItemType = {
|
|
787
|
+
id: string;
|
|
788
|
+
name: string;
|
|
789
|
+
description: string;
|
|
790
|
+
project_ids: string[];
|
|
791
|
+
logo_props: Record<string, unknown>;
|
|
792
|
+
is_epic: boolean;
|
|
793
|
+
is_default: boolean;
|
|
794
|
+
is_active: boolean;
|
|
795
|
+
level: number;
|
|
796
|
+
created_at: string;
|
|
797
|
+
updated_at: string;
|
|
798
|
+
deleted_at: string | null;
|
|
799
|
+
};
|
|
800
|
+
type WorkItemTypeSeed = {
|
|
801
|
+
name: string;
|
|
802
|
+
description?: string;
|
|
803
|
+
is_default?: boolean;
|
|
804
|
+
};
|
|
757
805
|
/** One project: its workspace slug and the per-project work-item sequence. */
|
|
758
806
|
type ProjectRecord = {
|
|
759
807
|
id: string;
|
|
@@ -786,6 +834,9 @@ declare class PlaneState {
|
|
|
786
834
|
readonly items: Collection<PlaneWorkItemRecord>;
|
|
787
835
|
readonly comments: Collection<PlaneCommentRecord>;
|
|
788
836
|
readonly links: Collection<PlaneLinkRecord>;
|
|
837
|
+
readonly cycles: Collection<PlaneCycleRecord>;
|
|
838
|
+
readonly memberships: Collection<PlaneCycleMembership>;
|
|
839
|
+
readonly types: Collection<PlaneWorkItemType>;
|
|
789
840
|
readonly settings: Collection<Settings>;
|
|
790
841
|
readonly rateLimits: Collection<number>;
|
|
791
842
|
private readonly ids;
|
|
@@ -963,10 +1014,10 @@ type OpenAPIDocument = {
|
|
|
963
1014
|
};
|
|
964
1015
|
|
|
965
1016
|
declare const document: OpenAPIDocument;
|
|
966
|
-
type OperationId = "ListWorkItems" | "CreateWorkItem" | "GetWorkItem" | "UpdateWorkItem" | "ListComments" | "CreateComment" | "ListLinks" | "CreateLink" | "ListStates" | "ListLabels" | "CreateLabel";
|
|
967
|
-
type SupportedOperationId = "ListWorkItems" | "CreateWorkItem" | "GetWorkItem" | "UpdateWorkItem" | "ListComments" | "CreateComment" | "ListLinks" | "CreateLink" | "ListStates" | "ListLabels" | "CreateLabel";
|
|
968
|
-
declare const operationIds: readonly ["ListWorkItems", "CreateWorkItem", "GetWorkItem", "UpdateWorkItem", "ListComments", "CreateComment", "ListLinks", "CreateLink", "ListStates", "ListLabels", "CreateLabel"];
|
|
969
|
-
declare const supportedOperationIds: readonly ["ListWorkItems", "CreateWorkItem", "GetWorkItem", "UpdateWorkItem", "ListComments", "CreateComment", "ListLinks", "CreateLink", "ListStates", "ListLabels", "CreateLabel"];
|
|
1017
|
+
type OperationId = "ListWorkItems" | "CreateWorkItem" | "GetWorkItem" | "UpdateWorkItem" | "ListComments" | "CreateComment" | "ListLinks" | "CreateLink" | "ListStates" | "ListLabels" | "CreateLabel" | "ListCycles" | "CreateCycle" | "ListCycleWorkItems" | "AddCycleWorkItems" | "ListWorkItemTypes";
|
|
1018
|
+
type SupportedOperationId = "ListWorkItems" | "CreateWorkItem" | "GetWorkItem" | "UpdateWorkItem" | "ListComments" | "CreateComment" | "ListLinks" | "CreateLink" | "ListStates" | "ListLabels" | "CreateLabel" | "ListCycles" | "CreateCycle" | "ListCycleWorkItems" | "AddCycleWorkItems" | "ListWorkItemTypes";
|
|
1019
|
+
declare const operationIds: readonly ["ListWorkItems", "CreateWorkItem", "GetWorkItem", "UpdateWorkItem", "ListComments", "CreateComment", "ListLinks", "CreateLink", "ListStates", "ListLabels", "CreateLabel", "ListCycles", "CreateCycle", "ListCycleWorkItems", "AddCycleWorkItems", "ListWorkItemTypes"];
|
|
1020
|
+
declare const supportedOperationIds: readonly ["ListWorkItems", "CreateWorkItem", "GetWorkItem", "UpdateWorkItem", "ListComments", "CreateComment", "ListLinks", "CreateLink", "ListStates", "ListLabels", "CreateLabel", "ListCycles", "CreateCycle", "ListCycleWorkItems", "AddCycleWorkItems", "ListWorkItemTypes"];
|
|
970
1021
|
|
|
971
1022
|
/**
|
|
972
1023
|
* Every named Plane misbehaviour our bug-report client branches on, switched on with
|
|
@@ -1020,11 +1071,20 @@ declare class PlaneAPI implements FetchAPI$1 {
|
|
|
1020
1071
|
private item;
|
|
1021
1072
|
statesOf(projectId: string): PlaneStateRecord[];
|
|
1022
1073
|
labelsOf(projectId: string): PlaneLabelRecord[];
|
|
1074
|
+
typesOf(projectId: string): PlaneWorkItemType[];
|
|
1075
|
+
/** Idempotent fixture provisioning; type IDs remain stable when metadata is reseeded. */
|
|
1076
|
+
seedWorkItemTypes(workspace: string, projectId: string, types: WorkItemTypeSeed[]): PlaneWorkItemType[] | undefined;
|
|
1023
1077
|
/** Plane's cursor paginator: `cursor=<per_page>:<page>:<is_prev>`, offset = page × per_page. */
|
|
1024
1078
|
private paginate;
|
|
1025
1079
|
private listWorkItems;
|
|
1080
|
+
private cycle;
|
|
1081
|
+
private cycleView;
|
|
1082
|
+
private listCycles;
|
|
1083
|
+
private createCycle;
|
|
1084
|
+
private listCycleWorkItems;
|
|
1085
|
+
private addCycleWorkItems;
|
|
1026
1086
|
private body;
|
|
1027
|
-
/** Validate
|
|
1087
|
+
/** Validate workflow references before any part of a write is persisted, DRF-style. */
|
|
1028
1088
|
private references;
|
|
1029
1089
|
private createWorkItem;
|
|
1030
1090
|
private updateWorkItem;
|
|
@@ -1042,4 +1102,4 @@ declare class PlaneAPI implements FetchAPI$1 {
|
|
|
1042
1102
|
}
|
|
1043
1103
|
|
|
1044
1104
|
export { DEFAULT_STATES, PLANE_NAMESPACE, PLANE_PRESETS, PlaneAPI, apiKeyCredential, createRuntime, document, operationIds, supportedOperationIds, uuidFrom };
|
|
1045
|
-
export type { FetchAPI$1 as FetchAPI, OperationId, PlaneAPIOptions, PlaneCommentRecord, PlaneLabelRecord, PlaneLinkRecord, PlaneRuntime, PlaneRuntimeOptions, PlaneStateRecord, PlaneWorkItemRecord, ProjectRecord, Settings, SqliteClient, StateGroup, SupportedOperationId };
|
|
1105
|
+
export type { FetchAPI$1 as FetchAPI, OperationId, PlaneAPIOptions, PlaneCommentRecord, PlaneCycleMembership, PlaneCycleRecord, PlaneLabelRecord, PlaneLinkRecord, PlaneRuntime, PlaneRuntimeOptions, PlaneStateRecord, PlaneWorkItemRecord, PlaneWorkItemType, ProjectRecord, Settings, SqliteClient, StateGroup, SupportedOperationId, WorkItemTypeSeed };
|
package/dist/index.js
CHANGED
package/dist/server.d.ts
CHANGED
|
@@ -1317,6 +1317,8 @@ type PlaneWorkItemRecord = {
|
|
|
1317
1317
|
description_stripped: string | null;
|
|
1318
1318
|
priority: "urgent" | "high" | "medium" | "low" | "none";
|
|
1319
1319
|
state: string;
|
|
1320
|
+
type_id: string | null;
|
|
1321
|
+
type: string | null;
|
|
1320
1322
|
labels: string[];
|
|
1321
1323
|
assignees: string[];
|
|
1322
1324
|
parent: string | null;
|
|
@@ -1356,6 +1358,52 @@ type PlaneLinkRecord = {
|
|
|
1356
1358
|
created_at: string;
|
|
1357
1359
|
updated_at: string;
|
|
1358
1360
|
};
|
|
1361
|
+
type PlaneCycleRecord = {
|
|
1362
|
+
id: string;
|
|
1363
|
+
name: string;
|
|
1364
|
+
description: string;
|
|
1365
|
+
start_date: string | null;
|
|
1366
|
+
end_date: string | null;
|
|
1367
|
+
owned_by: string | null;
|
|
1368
|
+
timezone: string;
|
|
1369
|
+
external_source: string | null;
|
|
1370
|
+
external_id: string | null;
|
|
1371
|
+
project: string;
|
|
1372
|
+
workspace: string;
|
|
1373
|
+
created_at: string;
|
|
1374
|
+
updated_at: string;
|
|
1375
|
+
archived_at: string | null;
|
|
1376
|
+
deleted_at: string | null;
|
|
1377
|
+
};
|
|
1378
|
+
type PlaneCycleMembership = {
|
|
1379
|
+
id: string;
|
|
1380
|
+
cycle: string;
|
|
1381
|
+
issue: string;
|
|
1382
|
+
project: string;
|
|
1383
|
+
workspace: string;
|
|
1384
|
+
created_at: string;
|
|
1385
|
+
updated_at: string;
|
|
1386
|
+
deleted_at: string | null;
|
|
1387
|
+
};
|
|
1388
|
+
type PlaneWorkItemType = {
|
|
1389
|
+
id: string;
|
|
1390
|
+
name: string;
|
|
1391
|
+
description: string;
|
|
1392
|
+
project_ids: string[];
|
|
1393
|
+
logo_props: Record<string, unknown>;
|
|
1394
|
+
is_epic: boolean;
|
|
1395
|
+
is_default: boolean;
|
|
1396
|
+
is_active: boolean;
|
|
1397
|
+
level: number;
|
|
1398
|
+
created_at: string;
|
|
1399
|
+
updated_at: string;
|
|
1400
|
+
deleted_at: string | null;
|
|
1401
|
+
};
|
|
1402
|
+
type WorkItemTypeSeed = {
|
|
1403
|
+
name: string;
|
|
1404
|
+
description?: string;
|
|
1405
|
+
is_default?: boolean;
|
|
1406
|
+
};
|
|
1359
1407
|
/** One project: its workspace slug and the per-project work-item sequence. */
|
|
1360
1408
|
type ProjectRecord = {
|
|
1361
1409
|
id: string;
|
|
@@ -1380,6 +1428,9 @@ declare class PlaneState {
|
|
|
1380
1428
|
readonly items: Collection<PlaneWorkItemRecord>;
|
|
1381
1429
|
readonly comments: Collection<PlaneCommentRecord>;
|
|
1382
1430
|
readonly links: Collection<PlaneLinkRecord>;
|
|
1431
|
+
readonly cycles: Collection<PlaneCycleRecord>;
|
|
1432
|
+
readonly memberships: Collection<PlaneCycleMembership>;
|
|
1433
|
+
readonly types: Collection<PlaneWorkItemType>;
|
|
1383
1434
|
readonly settings: Collection<Settings>;
|
|
1384
1435
|
readonly rateLimits: Collection<number>;
|
|
1385
1436
|
private readonly ids;
|
|
@@ -1416,11 +1467,20 @@ declare class PlaneAPI implements FetchAPI {
|
|
|
1416
1467
|
private item;
|
|
1417
1468
|
statesOf(projectId: string): PlaneStateRecord[];
|
|
1418
1469
|
labelsOf(projectId: string): PlaneLabelRecord[];
|
|
1470
|
+
typesOf(projectId: string): PlaneWorkItemType[];
|
|
1471
|
+
/** Idempotent fixture provisioning; type IDs remain stable when metadata is reseeded. */
|
|
1472
|
+
seedWorkItemTypes(workspace: string, projectId: string, types: WorkItemTypeSeed[]): PlaneWorkItemType[] | undefined;
|
|
1419
1473
|
/** Plane's cursor paginator: `cursor=<per_page>:<page>:<is_prev>`, offset = page × per_page. */
|
|
1420
1474
|
private paginate;
|
|
1421
1475
|
private listWorkItems;
|
|
1476
|
+
private cycle;
|
|
1477
|
+
private cycleView;
|
|
1478
|
+
private listCycles;
|
|
1479
|
+
private createCycle;
|
|
1480
|
+
private listCycleWorkItems;
|
|
1481
|
+
private addCycleWorkItems;
|
|
1422
1482
|
private body;
|
|
1423
|
-
/** Validate
|
|
1483
|
+
/** Validate workflow references before any part of a write is persisted, DRF-style. */
|
|
1424
1484
|
private references;
|
|
1425
1485
|
private createWorkItem;
|
|
1426
1486
|
private updateWorkItem;
|