@contractspec/example.project-management-sync 1.57.0 → 1.58.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/.turbo/turbo-build.log +34 -33
- package/.turbo/turbo-prebuild.log +1 -0
- package/CHANGELOG.md +13 -0
- package/dist/browser/docs/index.js +40 -0
- package/dist/browser/docs/project-management-sync.docblock.js +40 -0
- package/dist/browser/example.js +33 -0
- package/dist/browser/index.js +194 -0
- package/dist/browser/run.js +122 -0
- package/dist/browser/sync.js +122 -0
- package/dist/docs/index.d.ts +2 -1
- package/dist/docs/index.d.ts.map +1 -0
- package/dist/docs/index.js +41 -1
- package/dist/docs/project-management-sync.docblock.d.ts +2 -1
- package/dist/docs/project-management-sync.docblock.d.ts.map +1 -0
- package/dist/docs/project-management-sync.docblock.js +25 -30
- package/dist/example.d.ts +2 -6
- package/dist/example.d.ts.map +1 -1
- package/dist/example.js +32 -44
- package/dist/index.d.ts +4 -3
- package/dist/index.d.ts.map +1 -0
- package/dist/index.js +194 -4
- package/dist/node/docs/index.js +40 -0
- package/dist/node/docs/project-management-sync.docblock.js +40 -0
- package/dist/node/example.js +33 -0
- package/dist/node/index.js +194 -0
- package/dist/node/run.js +122 -0
- package/dist/node/sync.js +122 -0
- package/dist/run.d.ts +2 -1
- package/dist/run.d.ts.map +1 -0
- package/dist/run.js +119 -8
- package/dist/sync.d.ts +17 -21
- package/dist/sync.d.ts.map +1 -1
- package/dist/sync.js +107 -91
- package/package.json +69 -26
- package/tsdown.config.js +1 -2
- package/.turbo/turbo-build$colon$bundle.log +0 -33
- package/dist/docs/project-management-sync.docblock.js.map +0 -1
- package/dist/example.js.map +0 -1
- package/dist/run.js.map +0 -1
- package/dist/sync.js.map +0 -1
- package/tsconfig.tsbuildinfo +0 -1
|
@@ -0,0 +1,194 @@
|
|
|
1
|
+
// src/docs/project-management-sync.docblock.ts
|
|
2
|
+
import { registerDocBlocks } from "@contractspec/lib.contracts/docs";
|
|
3
|
+
var blocks = [
|
|
4
|
+
{
|
|
5
|
+
id: "docs.examples.project-management-sync",
|
|
6
|
+
title: "Project Management Sync (example)",
|
|
7
|
+
summary: "Create a shared payload of work items and sync it to Linear, Jira Cloud, or Notion.",
|
|
8
|
+
kind: "reference",
|
|
9
|
+
visibility: "public",
|
|
10
|
+
route: "/docs/examples/project-management-sync",
|
|
11
|
+
tags: ["project-management", "linear", "jira", "notion", "example"],
|
|
12
|
+
body: `## What this example shows
|
|
13
|
+
- Build a provider-agnostic payload of work items.
|
|
14
|
+
- Resolve the target provider from environment variables.
|
|
15
|
+
- Run in dry-run mode for preview output.
|
|
16
|
+
|
|
17
|
+
## Guardrails
|
|
18
|
+
- Keep secrets in env or secret providers only.
|
|
19
|
+
- Use dry-run to validate payloads before writing.
|
|
20
|
+
- Start with a small batch of tasks to validate setup.`
|
|
21
|
+
},
|
|
22
|
+
{
|
|
23
|
+
id: "docs.examples.project-management-sync.usage",
|
|
24
|
+
title: "Project Management Sync - Usage",
|
|
25
|
+
summary: "How to run the sync with env-driven provider settings.",
|
|
26
|
+
kind: "usage",
|
|
27
|
+
visibility: "public",
|
|
28
|
+
route: "/docs/examples/project-management-sync/usage",
|
|
29
|
+
tags: ["project-management", "usage"],
|
|
30
|
+
body: `## Usage
|
|
31
|
+
- Set CONTRACTSPEC_PM_PROVIDER to linear, jira, or notion.
|
|
32
|
+
- Set CONTRACTSPEC_PM_DRY_RUN=true to preview payloads.
|
|
33
|
+
- Provide provider-specific env vars (API keys, project IDs).
|
|
34
|
+
|
|
35
|
+
## Example
|
|
36
|
+
- Call runProjectManagementSyncFromEnv() from sync.ts or import it in your app.
|
|
37
|
+
- The helper builds a sample payload and calls the provider client.`
|
|
38
|
+
}
|
|
39
|
+
];
|
|
40
|
+
registerDocBlocks(blocks);
|
|
41
|
+
// src/example.ts
|
|
42
|
+
import { defineExample } from "@contractspec/lib.contracts";
|
|
43
|
+
var example = defineExample({
|
|
44
|
+
meta: {
|
|
45
|
+
key: "project-management-sync",
|
|
46
|
+
version: "1.0.0",
|
|
47
|
+
title: "Project Management Sync",
|
|
48
|
+
description: "Create project-management work items in Linear, Jira Cloud, or Notion from a shared payload.",
|
|
49
|
+
kind: "integration",
|
|
50
|
+
visibility: "public",
|
|
51
|
+
stability: "experimental",
|
|
52
|
+
owners: ["@platform.integrations"],
|
|
53
|
+
tags: ["project-management", "linear", "jira", "notion", "integrations"]
|
|
54
|
+
},
|
|
55
|
+
docs: {
|
|
56
|
+
rootDocId: "docs.examples.project-management-sync",
|
|
57
|
+
usageDocId: "docs.examples.project-management-sync.usage"
|
|
58
|
+
},
|
|
59
|
+
entrypoints: {
|
|
60
|
+
packageName: "@contractspec/example.project-management-sync",
|
|
61
|
+
docs: "./docs"
|
|
62
|
+
},
|
|
63
|
+
surfaces: {
|
|
64
|
+
templates: true,
|
|
65
|
+
sandbox: { enabled: true, modes: ["markdown", "specs"] },
|
|
66
|
+
studio: { enabled: true, installable: true },
|
|
67
|
+
mcp: { enabled: true }
|
|
68
|
+
}
|
|
69
|
+
});
|
|
70
|
+
var example_default = example;
|
|
71
|
+
|
|
72
|
+
// src/sync.ts
|
|
73
|
+
import {
|
|
74
|
+
JiraProjectManagementProvider,
|
|
75
|
+
LinearProjectManagementProvider,
|
|
76
|
+
NotionProjectManagementProvider
|
|
77
|
+
} from "@contractspec/integration.providers-impls/impls";
|
|
78
|
+
async function syncProjectManagementWorkItems(input) {
|
|
79
|
+
const items = input.items ?? buildSampleWorkItems();
|
|
80
|
+
const summary = input.summary;
|
|
81
|
+
const dryRun = input.dryRun ?? false;
|
|
82
|
+
if (dryRun) {
|
|
83
|
+
return { summary, items };
|
|
84
|
+
}
|
|
85
|
+
const provider = input.providerClient ?? createProviderFromEnv(input.provider);
|
|
86
|
+
const createdSummary = summary ? await provider.createWorkItem(summary) : undefined;
|
|
87
|
+
const createdItems = await provider.createWorkItems(items);
|
|
88
|
+
return { summary: createdSummary, items: createdItems };
|
|
89
|
+
}
|
|
90
|
+
async function runProjectManagementSyncFromEnv() {
|
|
91
|
+
const provider = resolveProviderName();
|
|
92
|
+
const dryRun = process.env.CONTRACTSPEC_PM_DRY_RUN === "true";
|
|
93
|
+
const summary = provider === "notion" ? buildSampleSummary() : undefined;
|
|
94
|
+
return syncProjectManagementWorkItems({
|
|
95
|
+
provider,
|
|
96
|
+
summary,
|
|
97
|
+
dryRun
|
|
98
|
+
});
|
|
99
|
+
}
|
|
100
|
+
function buildSampleWorkItems() {
|
|
101
|
+
return [
|
|
102
|
+
{
|
|
103
|
+
title: "Review onboarding drop-off",
|
|
104
|
+
description: "Analyze activation funnel to identify the highest drop-off step and propose fixes.",
|
|
105
|
+
type: "task",
|
|
106
|
+
priority: "high",
|
|
107
|
+
tags: ["onboarding", "insights"]
|
|
108
|
+
},
|
|
109
|
+
{
|
|
110
|
+
title: "Ship first-run checklist",
|
|
111
|
+
description: "Create a guided checklist with 3-5 steps to help new users reach first value.",
|
|
112
|
+
type: "task",
|
|
113
|
+
priority: "medium",
|
|
114
|
+
tags: ["activation", "ux"],
|
|
115
|
+
dueDate: new Date("2026-02-15")
|
|
116
|
+
},
|
|
117
|
+
{
|
|
118
|
+
title: "Define success metrics",
|
|
119
|
+
description: "Agree on activation success metrics and instrument key events.",
|
|
120
|
+
type: "task",
|
|
121
|
+
priority: "low",
|
|
122
|
+
tags: ["analytics", "tracking"]
|
|
123
|
+
}
|
|
124
|
+
];
|
|
125
|
+
}
|
|
126
|
+
function buildSampleSummary() {
|
|
127
|
+
return {
|
|
128
|
+
title: "Product Intent Summary",
|
|
129
|
+
description: "This summary aggregates the onboarding tasks and highlights the activation improvements to prioritize.",
|
|
130
|
+
type: "summary",
|
|
131
|
+
tags: ["product-intent", "summary"]
|
|
132
|
+
};
|
|
133
|
+
}
|
|
134
|
+
function createProviderFromEnv(provider) {
|
|
135
|
+
if (provider === "linear") {
|
|
136
|
+
return new LinearProjectManagementProvider({
|
|
137
|
+
apiKey: requireEnv("LINEAR_API_KEY"),
|
|
138
|
+
teamId: requireEnv("LINEAR_TEAM_ID"),
|
|
139
|
+
projectId: process.env.LINEAR_PROJECT_ID,
|
|
140
|
+
stateId: process.env.LINEAR_STATE_ID,
|
|
141
|
+
assigneeId: process.env.LINEAR_ASSIGNEE_ID,
|
|
142
|
+
labelIds: splitList(process.env.LINEAR_LABEL_IDS)
|
|
143
|
+
});
|
|
144
|
+
}
|
|
145
|
+
if (provider === "jira") {
|
|
146
|
+
return new JiraProjectManagementProvider({
|
|
147
|
+
siteUrl: requireEnv("JIRA_SITE_URL"),
|
|
148
|
+
email: requireEnv("JIRA_EMAIL"),
|
|
149
|
+
apiToken: requireEnv("JIRA_API_TOKEN"),
|
|
150
|
+
projectKey: process.env.JIRA_PROJECT_KEY,
|
|
151
|
+
issueType: process.env.JIRA_ISSUE_TYPE,
|
|
152
|
+
defaultLabels: splitList(process.env.JIRA_DEFAULT_LABELS)
|
|
153
|
+
});
|
|
154
|
+
}
|
|
155
|
+
return new NotionProjectManagementProvider({
|
|
156
|
+
apiKey: requireEnv("NOTION_API_KEY"),
|
|
157
|
+
databaseId: process.env.NOTION_DATABASE_ID,
|
|
158
|
+
summaryParentPageId: process.env.NOTION_SUMMARY_PARENT_PAGE_ID,
|
|
159
|
+
titleProperty: process.env.NOTION_TITLE_PROPERTY,
|
|
160
|
+
statusProperty: process.env.NOTION_STATUS_PROPERTY,
|
|
161
|
+
priorityProperty: process.env.NOTION_PRIORITY_PROPERTY,
|
|
162
|
+
tagsProperty: process.env.NOTION_TAGS_PROPERTY,
|
|
163
|
+
dueDateProperty: process.env.NOTION_DUE_DATE_PROPERTY,
|
|
164
|
+
descriptionProperty: process.env.NOTION_DESCRIPTION_PROPERTY
|
|
165
|
+
});
|
|
166
|
+
}
|
|
167
|
+
function resolveProviderName() {
|
|
168
|
+
const raw = (process.env.CONTRACTSPEC_PM_PROVIDER ?? "linear").toLowerCase();
|
|
169
|
+
if (raw === "linear" || raw === "jira" || raw === "notion")
|
|
170
|
+
return raw;
|
|
171
|
+
throw new Error(`Unsupported provider: ${raw}. Use one of: linear, jira, notion`);
|
|
172
|
+
}
|
|
173
|
+
function requireEnv(key) {
|
|
174
|
+
const value = process.env[key];
|
|
175
|
+
if (!value) {
|
|
176
|
+
throw new Error(`Missing required env var: ${key}`);
|
|
177
|
+
}
|
|
178
|
+
return value;
|
|
179
|
+
}
|
|
180
|
+
function splitList(value) {
|
|
181
|
+
if (!value)
|
|
182
|
+
return;
|
|
183
|
+
const items = value.split(",").map((item) => item.trim()).filter(Boolean);
|
|
184
|
+
return items.length > 0 ? items : undefined;
|
|
185
|
+
}
|
|
186
|
+
export {
|
|
187
|
+
syncProjectManagementWorkItems,
|
|
188
|
+
runProjectManagementSyncFromEnv,
|
|
189
|
+
resolveProviderName,
|
|
190
|
+
example_default as example,
|
|
191
|
+
createProviderFromEnv,
|
|
192
|
+
buildSampleWorkItems,
|
|
193
|
+
buildSampleSummary
|
|
194
|
+
};
|
package/dist/node/run.js
ADDED
|
@@ -0,0 +1,122 @@
|
|
|
1
|
+
// src/sync.ts
|
|
2
|
+
import {
|
|
3
|
+
JiraProjectManagementProvider,
|
|
4
|
+
LinearProjectManagementProvider,
|
|
5
|
+
NotionProjectManagementProvider
|
|
6
|
+
} from "@contractspec/integration.providers-impls/impls";
|
|
7
|
+
async function syncProjectManagementWorkItems(input) {
|
|
8
|
+
const items = input.items ?? buildSampleWorkItems();
|
|
9
|
+
const summary = input.summary;
|
|
10
|
+
const dryRun = input.dryRun ?? false;
|
|
11
|
+
if (dryRun) {
|
|
12
|
+
return { summary, items };
|
|
13
|
+
}
|
|
14
|
+
const provider = input.providerClient ?? createProviderFromEnv(input.provider);
|
|
15
|
+
const createdSummary = summary ? await provider.createWorkItem(summary) : undefined;
|
|
16
|
+
const createdItems = await provider.createWorkItems(items);
|
|
17
|
+
return { summary: createdSummary, items: createdItems };
|
|
18
|
+
}
|
|
19
|
+
async function runProjectManagementSyncFromEnv() {
|
|
20
|
+
const provider = resolveProviderName();
|
|
21
|
+
const dryRun = process.env.CONTRACTSPEC_PM_DRY_RUN === "true";
|
|
22
|
+
const summary = provider === "notion" ? buildSampleSummary() : undefined;
|
|
23
|
+
return syncProjectManagementWorkItems({
|
|
24
|
+
provider,
|
|
25
|
+
summary,
|
|
26
|
+
dryRun
|
|
27
|
+
});
|
|
28
|
+
}
|
|
29
|
+
function buildSampleWorkItems() {
|
|
30
|
+
return [
|
|
31
|
+
{
|
|
32
|
+
title: "Review onboarding drop-off",
|
|
33
|
+
description: "Analyze activation funnel to identify the highest drop-off step and propose fixes.",
|
|
34
|
+
type: "task",
|
|
35
|
+
priority: "high",
|
|
36
|
+
tags: ["onboarding", "insights"]
|
|
37
|
+
},
|
|
38
|
+
{
|
|
39
|
+
title: "Ship first-run checklist",
|
|
40
|
+
description: "Create a guided checklist with 3-5 steps to help new users reach first value.",
|
|
41
|
+
type: "task",
|
|
42
|
+
priority: "medium",
|
|
43
|
+
tags: ["activation", "ux"],
|
|
44
|
+
dueDate: new Date("2026-02-15")
|
|
45
|
+
},
|
|
46
|
+
{
|
|
47
|
+
title: "Define success metrics",
|
|
48
|
+
description: "Agree on activation success metrics and instrument key events.",
|
|
49
|
+
type: "task",
|
|
50
|
+
priority: "low",
|
|
51
|
+
tags: ["analytics", "tracking"]
|
|
52
|
+
}
|
|
53
|
+
];
|
|
54
|
+
}
|
|
55
|
+
function buildSampleSummary() {
|
|
56
|
+
return {
|
|
57
|
+
title: "Product Intent Summary",
|
|
58
|
+
description: "This summary aggregates the onboarding tasks and highlights the activation improvements to prioritize.",
|
|
59
|
+
type: "summary",
|
|
60
|
+
tags: ["product-intent", "summary"]
|
|
61
|
+
};
|
|
62
|
+
}
|
|
63
|
+
function createProviderFromEnv(provider) {
|
|
64
|
+
if (provider === "linear") {
|
|
65
|
+
return new LinearProjectManagementProvider({
|
|
66
|
+
apiKey: requireEnv("LINEAR_API_KEY"),
|
|
67
|
+
teamId: requireEnv("LINEAR_TEAM_ID"),
|
|
68
|
+
projectId: process.env.LINEAR_PROJECT_ID,
|
|
69
|
+
stateId: process.env.LINEAR_STATE_ID,
|
|
70
|
+
assigneeId: process.env.LINEAR_ASSIGNEE_ID,
|
|
71
|
+
labelIds: splitList(process.env.LINEAR_LABEL_IDS)
|
|
72
|
+
});
|
|
73
|
+
}
|
|
74
|
+
if (provider === "jira") {
|
|
75
|
+
return new JiraProjectManagementProvider({
|
|
76
|
+
siteUrl: requireEnv("JIRA_SITE_URL"),
|
|
77
|
+
email: requireEnv("JIRA_EMAIL"),
|
|
78
|
+
apiToken: requireEnv("JIRA_API_TOKEN"),
|
|
79
|
+
projectKey: process.env.JIRA_PROJECT_KEY,
|
|
80
|
+
issueType: process.env.JIRA_ISSUE_TYPE,
|
|
81
|
+
defaultLabels: splitList(process.env.JIRA_DEFAULT_LABELS)
|
|
82
|
+
});
|
|
83
|
+
}
|
|
84
|
+
return new NotionProjectManagementProvider({
|
|
85
|
+
apiKey: requireEnv("NOTION_API_KEY"),
|
|
86
|
+
databaseId: process.env.NOTION_DATABASE_ID,
|
|
87
|
+
summaryParentPageId: process.env.NOTION_SUMMARY_PARENT_PAGE_ID,
|
|
88
|
+
titleProperty: process.env.NOTION_TITLE_PROPERTY,
|
|
89
|
+
statusProperty: process.env.NOTION_STATUS_PROPERTY,
|
|
90
|
+
priorityProperty: process.env.NOTION_PRIORITY_PROPERTY,
|
|
91
|
+
tagsProperty: process.env.NOTION_TAGS_PROPERTY,
|
|
92
|
+
dueDateProperty: process.env.NOTION_DUE_DATE_PROPERTY,
|
|
93
|
+
descriptionProperty: process.env.NOTION_DESCRIPTION_PROPERTY
|
|
94
|
+
});
|
|
95
|
+
}
|
|
96
|
+
function resolveProviderName() {
|
|
97
|
+
const raw = (process.env.CONTRACTSPEC_PM_PROVIDER ?? "linear").toLowerCase();
|
|
98
|
+
if (raw === "linear" || raw === "jira" || raw === "notion")
|
|
99
|
+
return raw;
|
|
100
|
+
throw new Error(`Unsupported provider: ${raw}. Use one of: linear, jira, notion`);
|
|
101
|
+
}
|
|
102
|
+
function requireEnv(key) {
|
|
103
|
+
const value = process.env[key];
|
|
104
|
+
if (!value) {
|
|
105
|
+
throw new Error(`Missing required env var: ${key}`);
|
|
106
|
+
}
|
|
107
|
+
return value;
|
|
108
|
+
}
|
|
109
|
+
function splitList(value) {
|
|
110
|
+
if (!value)
|
|
111
|
+
return;
|
|
112
|
+
const items = value.split(",").map((item) => item.trim()).filter(Boolean);
|
|
113
|
+
return items.length > 0 ? items : undefined;
|
|
114
|
+
}
|
|
115
|
+
|
|
116
|
+
// src/run.ts
|
|
117
|
+
runProjectManagementSyncFromEnv().then((result) => {
|
|
118
|
+
console.log(JSON.stringify(result, null, 2));
|
|
119
|
+
}).catch((error) => {
|
|
120
|
+
console.error(error);
|
|
121
|
+
process.exitCode = 1;
|
|
122
|
+
});
|
|
@@ -0,0 +1,122 @@
|
|
|
1
|
+
// src/sync.ts
|
|
2
|
+
import {
|
|
3
|
+
JiraProjectManagementProvider,
|
|
4
|
+
LinearProjectManagementProvider,
|
|
5
|
+
NotionProjectManagementProvider
|
|
6
|
+
} from "@contractspec/integration.providers-impls/impls";
|
|
7
|
+
async function syncProjectManagementWorkItems(input) {
|
|
8
|
+
const items = input.items ?? buildSampleWorkItems();
|
|
9
|
+
const summary = input.summary;
|
|
10
|
+
const dryRun = input.dryRun ?? false;
|
|
11
|
+
if (dryRun) {
|
|
12
|
+
return { summary, items };
|
|
13
|
+
}
|
|
14
|
+
const provider = input.providerClient ?? createProviderFromEnv(input.provider);
|
|
15
|
+
const createdSummary = summary ? await provider.createWorkItem(summary) : undefined;
|
|
16
|
+
const createdItems = await provider.createWorkItems(items);
|
|
17
|
+
return { summary: createdSummary, items: createdItems };
|
|
18
|
+
}
|
|
19
|
+
async function runProjectManagementSyncFromEnv() {
|
|
20
|
+
const provider = resolveProviderName();
|
|
21
|
+
const dryRun = process.env.CONTRACTSPEC_PM_DRY_RUN === "true";
|
|
22
|
+
const summary = provider === "notion" ? buildSampleSummary() : undefined;
|
|
23
|
+
return syncProjectManagementWorkItems({
|
|
24
|
+
provider,
|
|
25
|
+
summary,
|
|
26
|
+
dryRun
|
|
27
|
+
});
|
|
28
|
+
}
|
|
29
|
+
function buildSampleWorkItems() {
|
|
30
|
+
return [
|
|
31
|
+
{
|
|
32
|
+
title: "Review onboarding drop-off",
|
|
33
|
+
description: "Analyze activation funnel to identify the highest drop-off step and propose fixes.",
|
|
34
|
+
type: "task",
|
|
35
|
+
priority: "high",
|
|
36
|
+
tags: ["onboarding", "insights"]
|
|
37
|
+
},
|
|
38
|
+
{
|
|
39
|
+
title: "Ship first-run checklist",
|
|
40
|
+
description: "Create a guided checklist with 3-5 steps to help new users reach first value.",
|
|
41
|
+
type: "task",
|
|
42
|
+
priority: "medium",
|
|
43
|
+
tags: ["activation", "ux"],
|
|
44
|
+
dueDate: new Date("2026-02-15")
|
|
45
|
+
},
|
|
46
|
+
{
|
|
47
|
+
title: "Define success metrics",
|
|
48
|
+
description: "Agree on activation success metrics and instrument key events.",
|
|
49
|
+
type: "task",
|
|
50
|
+
priority: "low",
|
|
51
|
+
tags: ["analytics", "tracking"]
|
|
52
|
+
}
|
|
53
|
+
];
|
|
54
|
+
}
|
|
55
|
+
function buildSampleSummary() {
|
|
56
|
+
return {
|
|
57
|
+
title: "Product Intent Summary",
|
|
58
|
+
description: "This summary aggregates the onboarding tasks and highlights the activation improvements to prioritize.",
|
|
59
|
+
type: "summary",
|
|
60
|
+
tags: ["product-intent", "summary"]
|
|
61
|
+
};
|
|
62
|
+
}
|
|
63
|
+
function createProviderFromEnv(provider) {
|
|
64
|
+
if (provider === "linear") {
|
|
65
|
+
return new LinearProjectManagementProvider({
|
|
66
|
+
apiKey: requireEnv("LINEAR_API_KEY"),
|
|
67
|
+
teamId: requireEnv("LINEAR_TEAM_ID"),
|
|
68
|
+
projectId: process.env.LINEAR_PROJECT_ID,
|
|
69
|
+
stateId: process.env.LINEAR_STATE_ID,
|
|
70
|
+
assigneeId: process.env.LINEAR_ASSIGNEE_ID,
|
|
71
|
+
labelIds: splitList(process.env.LINEAR_LABEL_IDS)
|
|
72
|
+
});
|
|
73
|
+
}
|
|
74
|
+
if (provider === "jira") {
|
|
75
|
+
return new JiraProjectManagementProvider({
|
|
76
|
+
siteUrl: requireEnv("JIRA_SITE_URL"),
|
|
77
|
+
email: requireEnv("JIRA_EMAIL"),
|
|
78
|
+
apiToken: requireEnv("JIRA_API_TOKEN"),
|
|
79
|
+
projectKey: process.env.JIRA_PROJECT_KEY,
|
|
80
|
+
issueType: process.env.JIRA_ISSUE_TYPE,
|
|
81
|
+
defaultLabels: splitList(process.env.JIRA_DEFAULT_LABELS)
|
|
82
|
+
});
|
|
83
|
+
}
|
|
84
|
+
return new NotionProjectManagementProvider({
|
|
85
|
+
apiKey: requireEnv("NOTION_API_KEY"),
|
|
86
|
+
databaseId: process.env.NOTION_DATABASE_ID,
|
|
87
|
+
summaryParentPageId: process.env.NOTION_SUMMARY_PARENT_PAGE_ID,
|
|
88
|
+
titleProperty: process.env.NOTION_TITLE_PROPERTY,
|
|
89
|
+
statusProperty: process.env.NOTION_STATUS_PROPERTY,
|
|
90
|
+
priorityProperty: process.env.NOTION_PRIORITY_PROPERTY,
|
|
91
|
+
tagsProperty: process.env.NOTION_TAGS_PROPERTY,
|
|
92
|
+
dueDateProperty: process.env.NOTION_DUE_DATE_PROPERTY,
|
|
93
|
+
descriptionProperty: process.env.NOTION_DESCRIPTION_PROPERTY
|
|
94
|
+
});
|
|
95
|
+
}
|
|
96
|
+
function resolveProviderName() {
|
|
97
|
+
const raw = (process.env.CONTRACTSPEC_PM_PROVIDER ?? "linear").toLowerCase();
|
|
98
|
+
if (raw === "linear" || raw === "jira" || raw === "notion")
|
|
99
|
+
return raw;
|
|
100
|
+
throw new Error(`Unsupported provider: ${raw}. Use one of: linear, jira, notion`);
|
|
101
|
+
}
|
|
102
|
+
function requireEnv(key) {
|
|
103
|
+
const value = process.env[key];
|
|
104
|
+
if (!value) {
|
|
105
|
+
throw new Error(`Missing required env var: ${key}`);
|
|
106
|
+
}
|
|
107
|
+
return value;
|
|
108
|
+
}
|
|
109
|
+
function splitList(value) {
|
|
110
|
+
if (!value)
|
|
111
|
+
return;
|
|
112
|
+
const items = value.split(",").map((item) => item.trim()).filter(Boolean);
|
|
113
|
+
return items.length > 0 ? items : undefined;
|
|
114
|
+
}
|
|
115
|
+
export {
|
|
116
|
+
syncProjectManagementWorkItems,
|
|
117
|
+
runProjectManagementSyncFromEnv,
|
|
118
|
+
resolveProviderName,
|
|
119
|
+
createProviderFromEnv,
|
|
120
|
+
buildSampleWorkItems,
|
|
121
|
+
buildSampleSummary
|
|
122
|
+
};
|
package/dist/run.d.ts
CHANGED
|
@@ -1 +1,2 @@
|
|
|
1
|
-
export {
|
|
1
|
+
export {};
|
|
2
|
+
//# sourceMappingURL=run.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"run.d.ts","sourceRoot":"","sources":["../src/run.ts"],"names":[],"mappings":""}
|
package/dist/run.js
CHANGED
|
@@ -1,12 +1,123 @@
|
|
|
1
|
-
|
|
1
|
+
// @bun
|
|
2
|
+
// src/sync.ts
|
|
3
|
+
import {
|
|
4
|
+
JiraProjectManagementProvider,
|
|
5
|
+
LinearProjectManagementProvider,
|
|
6
|
+
NotionProjectManagementProvider
|
|
7
|
+
} from "@contractspec/integration.providers-impls/impls";
|
|
8
|
+
async function syncProjectManagementWorkItems(input) {
|
|
9
|
+
const items = input.items ?? buildSampleWorkItems();
|
|
10
|
+
const summary = input.summary;
|
|
11
|
+
const dryRun = input.dryRun ?? false;
|
|
12
|
+
if (dryRun) {
|
|
13
|
+
return { summary, items };
|
|
14
|
+
}
|
|
15
|
+
const provider = input.providerClient ?? createProviderFromEnv(input.provider);
|
|
16
|
+
const createdSummary = summary ? await provider.createWorkItem(summary) : undefined;
|
|
17
|
+
const createdItems = await provider.createWorkItems(items);
|
|
18
|
+
return { summary: createdSummary, items: createdItems };
|
|
19
|
+
}
|
|
20
|
+
async function runProjectManagementSyncFromEnv() {
|
|
21
|
+
const provider = resolveProviderName();
|
|
22
|
+
const dryRun = process.env.CONTRACTSPEC_PM_DRY_RUN === "true";
|
|
23
|
+
const summary = provider === "notion" ? buildSampleSummary() : undefined;
|
|
24
|
+
return syncProjectManagementWorkItems({
|
|
25
|
+
provider,
|
|
26
|
+
summary,
|
|
27
|
+
dryRun
|
|
28
|
+
});
|
|
29
|
+
}
|
|
30
|
+
function buildSampleWorkItems() {
|
|
31
|
+
return [
|
|
32
|
+
{
|
|
33
|
+
title: "Review onboarding drop-off",
|
|
34
|
+
description: "Analyze activation funnel to identify the highest drop-off step and propose fixes.",
|
|
35
|
+
type: "task",
|
|
36
|
+
priority: "high",
|
|
37
|
+
tags: ["onboarding", "insights"]
|
|
38
|
+
},
|
|
39
|
+
{
|
|
40
|
+
title: "Ship first-run checklist",
|
|
41
|
+
description: "Create a guided checklist with 3-5 steps to help new users reach first value.",
|
|
42
|
+
type: "task",
|
|
43
|
+
priority: "medium",
|
|
44
|
+
tags: ["activation", "ux"],
|
|
45
|
+
dueDate: new Date("2026-02-15")
|
|
46
|
+
},
|
|
47
|
+
{
|
|
48
|
+
title: "Define success metrics",
|
|
49
|
+
description: "Agree on activation success metrics and instrument key events.",
|
|
50
|
+
type: "task",
|
|
51
|
+
priority: "low",
|
|
52
|
+
tags: ["analytics", "tracking"]
|
|
53
|
+
}
|
|
54
|
+
];
|
|
55
|
+
}
|
|
56
|
+
function buildSampleSummary() {
|
|
57
|
+
return {
|
|
58
|
+
title: "Product Intent Summary",
|
|
59
|
+
description: "This summary aggregates the onboarding tasks and highlights the activation improvements to prioritize.",
|
|
60
|
+
type: "summary",
|
|
61
|
+
tags: ["product-intent", "summary"]
|
|
62
|
+
};
|
|
63
|
+
}
|
|
64
|
+
function createProviderFromEnv(provider) {
|
|
65
|
+
if (provider === "linear") {
|
|
66
|
+
return new LinearProjectManagementProvider({
|
|
67
|
+
apiKey: requireEnv("LINEAR_API_KEY"),
|
|
68
|
+
teamId: requireEnv("LINEAR_TEAM_ID"),
|
|
69
|
+
projectId: process.env.LINEAR_PROJECT_ID,
|
|
70
|
+
stateId: process.env.LINEAR_STATE_ID,
|
|
71
|
+
assigneeId: process.env.LINEAR_ASSIGNEE_ID,
|
|
72
|
+
labelIds: splitList(process.env.LINEAR_LABEL_IDS)
|
|
73
|
+
});
|
|
74
|
+
}
|
|
75
|
+
if (provider === "jira") {
|
|
76
|
+
return new JiraProjectManagementProvider({
|
|
77
|
+
siteUrl: requireEnv("JIRA_SITE_URL"),
|
|
78
|
+
email: requireEnv("JIRA_EMAIL"),
|
|
79
|
+
apiToken: requireEnv("JIRA_API_TOKEN"),
|
|
80
|
+
projectKey: process.env.JIRA_PROJECT_KEY,
|
|
81
|
+
issueType: process.env.JIRA_ISSUE_TYPE,
|
|
82
|
+
defaultLabels: splitList(process.env.JIRA_DEFAULT_LABELS)
|
|
83
|
+
});
|
|
84
|
+
}
|
|
85
|
+
return new NotionProjectManagementProvider({
|
|
86
|
+
apiKey: requireEnv("NOTION_API_KEY"),
|
|
87
|
+
databaseId: process.env.NOTION_DATABASE_ID,
|
|
88
|
+
summaryParentPageId: process.env.NOTION_SUMMARY_PARENT_PAGE_ID,
|
|
89
|
+
titleProperty: process.env.NOTION_TITLE_PROPERTY,
|
|
90
|
+
statusProperty: process.env.NOTION_STATUS_PROPERTY,
|
|
91
|
+
priorityProperty: process.env.NOTION_PRIORITY_PROPERTY,
|
|
92
|
+
tagsProperty: process.env.NOTION_TAGS_PROPERTY,
|
|
93
|
+
dueDateProperty: process.env.NOTION_DUE_DATE_PROPERTY,
|
|
94
|
+
descriptionProperty: process.env.NOTION_DESCRIPTION_PROPERTY
|
|
95
|
+
});
|
|
96
|
+
}
|
|
97
|
+
function resolveProviderName() {
|
|
98
|
+
const raw = (process.env.CONTRACTSPEC_PM_PROVIDER ?? "linear").toLowerCase();
|
|
99
|
+
if (raw === "linear" || raw === "jira" || raw === "notion")
|
|
100
|
+
return raw;
|
|
101
|
+
throw new Error(`Unsupported provider: ${raw}. Use one of: linear, jira, notion`);
|
|
102
|
+
}
|
|
103
|
+
function requireEnv(key) {
|
|
104
|
+
const value = process.env[key];
|
|
105
|
+
if (!value) {
|
|
106
|
+
throw new Error(`Missing required env var: ${key}`);
|
|
107
|
+
}
|
|
108
|
+
return value;
|
|
109
|
+
}
|
|
110
|
+
function splitList(value) {
|
|
111
|
+
if (!value)
|
|
112
|
+
return;
|
|
113
|
+
const items = value.split(",").map((item) => item.trim()).filter(Boolean);
|
|
114
|
+
return items.length > 0 ? items : undefined;
|
|
115
|
+
}
|
|
2
116
|
|
|
3
|
-
|
|
117
|
+
// src/run.ts
|
|
4
118
|
runProjectManagementSyncFromEnv().then((result) => {
|
|
5
|
-
|
|
119
|
+
console.log(JSON.stringify(result, null, 2));
|
|
6
120
|
}).catch((error) => {
|
|
7
|
-
|
|
8
|
-
|
|
121
|
+
console.error(error);
|
|
122
|
+
process.exitCode = 1;
|
|
9
123
|
});
|
|
10
|
-
|
|
11
|
-
//#endregion
|
|
12
|
-
//# sourceMappingURL=run.js.map
|
package/dist/sync.d.ts
CHANGED
|
@@ -1,24 +1,20 @@
|
|
|
1
|
-
import { ProjectManagementProvider, ProjectManagementWorkItem, ProjectManagementWorkItemInput } from
|
|
2
|
-
|
|
3
|
-
|
|
4
|
-
|
|
5
|
-
|
|
6
|
-
|
|
7
|
-
|
|
8
|
-
|
|
9
|
-
summary?: ProjectManagementWorkItemInput;
|
|
10
|
-
dryRun?: boolean;
|
|
1
|
+
import type { ProjectManagementProvider, ProjectManagementWorkItem, ProjectManagementWorkItemInput } from '@contractspec/integration.providers-impls/project-management';
|
|
2
|
+
export type ProjectManagementProviderName = 'linear' | 'jira' | 'notion';
|
|
3
|
+
export interface ProjectManagementSyncInput {
|
|
4
|
+
provider: ProjectManagementProviderName;
|
|
5
|
+
providerClient?: ProjectManagementProvider;
|
|
6
|
+
items?: ProjectManagementWorkItemInput[];
|
|
7
|
+
summary?: ProjectManagementWorkItemInput;
|
|
8
|
+
dryRun?: boolean;
|
|
11
9
|
}
|
|
12
|
-
interface ProjectManagementSyncOutput {
|
|
13
|
-
|
|
14
|
-
|
|
10
|
+
export interface ProjectManagementSyncOutput {
|
|
11
|
+
summary?: ProjectManagementWorkItem | ProjectManagementWorkItemInput;
|
|
12
|
+
items: ProjectManagementWorkItem[] | ProjectManagementWorkItemInput[];
|
|
15
13
|
}
|
|
16
|
-
declare function syncProjectManagementWorkItems(input: ProjectManagementSyncInput): Promise<ProjectManagementSyncOutput>;
|
|
17
|
-
declare function runProjectManagementSyncFromEnv(): Promise<ProjectManagementSyncOutput>;
|
|
18
|
-
declare function buildSampleWorkItems(): ProjectManagementWorkItemInput[];
|
|
19
|
-
declare function buildSampleSummary(): ProjectManagementWorkItemInput;
|
|
20
|
-
declare function createProviderFromEnv(provider: ProjectManagementProviderName): ProjectManagementProvider;
|
|
21
|
-
declare function resolveProviderName(): ProjectManagementProviderName;
|
|
22
|
-
//#endregion
|
|
23
|
-
export { ProjectManagementProviderName, ProjectManagementSyncInput, ProjectManagementSyncOutput, buildSampleSummary, buildSampleWorkItems, createProviderFromEnv, resolveProviderName, runProjectManagementSyncFromEnv, syncProjectManagementWorkItems };
|
|
14
|
+
export declare function syncProjectManagementWorkItems(input: ProjectManagementSyncInput): Promise<ProjectManagementSyncOutput>;
|
|
15
|
+
export declare function runProjectManagementSyncFromEnv(): Promise<ProjectManagementSyncOutput>;
|
|
16
|
+
export declare function buildSampleWorkItems(): ProjectManagementWorkItemInput[];
|
|
17
|
+
export declare function buildSampleSummary(): ProjectManagementWorkItemInput;
|
|
18
|
+
export declare function createProviderFromEnv(provider: ProjectManagementProviderName): ProjectManagementProvider;
|
|
19
|
+
export declare function resolveProviderName(): ProjectManagementProviderName;
|
|
24
20
|
//# sourceMappingURL=sync.d.ts.map
|
package/dist/sync.d.ts.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"sync.d.ts","
|
|
1
|
+
{"version":3,"file":"sync.d.ts","sourceRoot":"","sources":["../src/sync.ts"],"names":[],"mappings":"AAKA,OAAO,KAAK,EACV,yBAAyB,EACzB,yBAAyB,EACzB,8BAA8B,EAC/B,MAAM,8DAA8D,CAAC;AAEtE,MAAM,MAAM,6BAA6B,GAAG,QAAQ,GAAG,MAAM,GAAG,QAAQ,CAAC;AAEzE,MAAM,WAAW,0BAA0B;IACzC,QAAQ,EAAE,6BAA6B,CAAC;IACxC,cAAc,CAAC,EAAE,yBAAyB,CAAC;IAC3C,KAAK,CAAC,EAAE,8BAA8B,EAAE,CAAC;IACzC,OAAO,CAAC,EAAE,8BAA8B,CAAC;IACzC,MAAM,CAAC,EAAE,OAAO,CAAC;CAClB;AAED,MAAM,WAAW,2BAA2B;IAC1C,OAAO,CAAC,EAAE,yBAAyB,GAAG,8BAA8B,CAAC;IACrE,KAAK,EAAE,yBAAyB,EAAE,GAAG,8BAA8B,EAAE,CAAC;CACvE;AAED,wBAAsB,8BAA8B,CAClD,KAAK,EAAE,0BAA0B,GAChC,OAAO,CAAC,2BAA2B,CAAC,CAgBtC;AAED,wBAAsB,+BAA+B,IAAI,OAAO,CAAC,2BAA2B,CAAC,CAS5F;AAED,wBAAgB,oBAAoB,IAAI,8BAA8B,EAAE,CA4BvE;AAED,wBAAgB,kBAAkB,IAAI,8BAA8B,CAQnE;AAED,wBAAgB,qBAAqB,CACnC,QAAQ,EAAE,6BAA6B,GACtC,yBAAyB,CAkC3B;AAED,wBAAgB,mBAAmB,IAAI,6BAA6B,CAMnE"}
|