@contractspec/example.project-management-sync 1.57.0 → 1.59.0

package/dist/docs/index.js

@@ -1 +1,41 @@
-import "./project-management-sync.docblock.js";
+// @bun
+// src/docs/project-management-sync.docblock.ts
+import { registerDocBlocks } from "@contractspec/lib.contracts/docs";
+var blocks = [
+  {
+    id: "docs.examples.project-management-sync",
+    title: "Project Management Sync (example)",
+    summary: "Create a shared payload of work items and sync it to Linear, Jira Cloud, or Notion.",
+    kind: "reference",
+    visibility: "public",
+    route: "/docs/examples/project-management-sync",
+    tags: ["project-management", "linear", "jira", "notion", "example"],
+    body: `## What this example shows
+- Build a provider-agnostic payload of work items.
+- Resolve the target provider from environment variables.
+- Run in dry-run mode for preview output.
+
+## Guardrails
+- Keep secrets in env or secret providers only.
+- Use dry-run to validate payloads before writing.
+- Start with a small batch of tasks to validate setup.`
+  },
+  {
+    id: "docs.examples.project-management-sync.usage",
+    title: "Project Management Sync - Usage",
+    summary: "How to run the sync with env-driven provider settings.",
+    kind: "usage",
+    visibility: "public",
+    route: "/docs/examples/project-management-sync/usage",
+    tags: ["project-management", "usage"],
+    body: `## Usage
+- Set CONTRACTSPEC_PM_PROVIDER to linear, jira, or notion.
+- Set CONTRACTSPEC_PM_DRY_RUN=true to preview payloads.
+- Provide provider-specific env vars (API keys, project IDs).
+
+## Example
+- Call runProjectManagementSyncFromEnv() from sync.ts or import it in your app.
+- The helper builds a sample payload and calls the provider client.`
+  }
+];
+registerDocBlocks(blocks);

package/dist/docs/project-management-sync.docblock.d.ts

@@ -1 +1,2 @@
-export { };
+export {};
+//# sourceMappingURL=project-management-sync.docblock.d.ts.map

package/dist/docs/project-management-sync.docblock.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"project-management-sync.docblock.d.ts","sourceRoot":"","sources":["../../src/docs/project-management-sync.docblock.ts"],"names":[],"mappings":""}

package/dist/docs/project-management-sync.docblock.js

@@ -1,21 +1,16 @@
+// @bun
+// src/docs/project-management-sync.docblock.ts
 import { registerDocBlocks } from "@contractspec/lib.contracts/docs";
-
-//#region src/docs/project-management-sync.docblock.ts
-registerDocBlocks([{
-	id: "docs.examples.project-management-sync",
-	title: "Project Management Sync (example)",
-	summary: "Create a shared payload of work items and sync it to Linear, Jira Cloud, or Notion.",
-	kind: "reference",
-	visibility: "public",
-	route: "/docs/examples/project-management-sync",
-	tags: [
-		"project-management",
-		"linear",
-		"jira",
-		"notion",
-		"example"
-	],
-	body: `## What this example shows
+var blocks = [
+  {
+    id: "docs.examples.project-management-sync",
+    title: "Project Management Sync (example)",
+    summary: "Create a shared payload of work items and sync it to Linear, Jira Cloud, or Notion.",
+    kind: "reference",
+    visibility: "public",
+    route: "/docs/examples/project-management-sync",
+    tags: ["project-management", "linear", "jira", "notion", "example"],
+    body: `## What this example shows
 - Build a provider-agnostic payload of work items.
 - Resolve the target provider from environment variables.
 - Run in dry-run mode for preview output.
@@ -24,15 +19,16 @@ registerDocBlocks([{
 - Keep secrets in env or secret providers only.
 - Use dry-run to validate payloads before writing.
 - Start with a small batch of tasks to validate setup.`
-}, {
-	id: "docs.examples.project-management-sync.usage",
-	title: "Project Management Sync - Usage",
-	summary: "How to run the sync with env-driven provider settings.",
-	kind: "usage",
-	visibility: "public",
-	route: "/docs/examples/project-management-sync/usage",
-	tags: ["project-management", "usage"],
-	body: `## Usage
+  },
+  {
+    id: "docs.examples.project-management-sync.usage",
+    title: "Project Management Sync - Usage",
+    summary: "How to run the sync with env-driven provider settings.",
+    kind: "usage",
+    visibility: "public",
+    route: "/docs/examples/project-management-sync/usage",
+    tags: ["project-management", "usage"],
+    body: `## Usage
 - Set CONTRACTSPEC_PM_PROVIDER to linear, jira, or notion.
 - Set CONTRACTSPEC_PM_DRY_RUN=true to preview payloads.
 - Provide provider-specific env vars (API keys, project IDs).
@@ -40,7 +36,6 @@ registerDocBlocks([{
 ## Example
 - Call runProjectManagementSyncFromEnv() from sync.ts or import it in your app.
 - The helper builds a sample payload and calls the provider client.`
-}]);
-
-//#endregion
-//# sourceMappingURL=project-management-sync.docblock.js.map
+  }
+];
+registerDocBlocks(blocks);

package/dist/example.d.ts

@@ -1,7 +1,3 @@
-import * as _contractspec_lib_contracts0 from "@contractspec/lib.contracts";
-
-//#region src/example.d.ts
-declare const example: _contractspec_lib_contracts0.ExampleSpec;
-//#endregion
-export { example as default };
+declare const example: import("@contractspec/lib.contracts").ExampleSpec;
+export default example;
 //# sourceMappingURL=example.d.ts.map

package/dist/example.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"example.d.ts","names":[],"sources":["../src/example.ts"],"mappings":";;;cAEM,OAAA,EA2BJ,4BAAA,CA3BW,WAAA"}
+{"version":3,"file":"example.d.ts","sourceRoot":"","sources":["../src/example.ts"],"names":[],"mappings":"AAEA,QAAA,MAAM,OAAO,mDA2BX,CAAC;AAEH,eAAe,OAAO,CAAC"}

package/dist/example.js

@@ -1,46 +1,34 @@
+// @bun
+// src/example.ts
 import { defineExample } from "@contractspec/lib.contracts";
-
-//#region src/example.ts
-const example = defineExample({
-	meta: {
-		key: "project-management-sync",
-		version: "1.0.0",
-		title: "Project Management Sync",
-		description: "Create project-management work items in Linear, Jira Cloud, or Notion from a shared payload.",
-		kind: "integration",
-		visibility: "public",
-		stability: "experimental",
-		owners: ["@platform.integrations"],
-		tags: [
-			"project-management",
-			"linear",
-			"jira",
-			"notion",
-			"integrations"
-		]
-	},
-	docs: {
-		rootDocId: "docs.examples.project-management-sync",
-		usageDocId: "docs.examples.project-management-sync.usage"
-	},
-	entrypoints: {
-		packageName: "@contractspec/example.project-management-sync",
-		docs: "./docs"
-	},
-	surfaces: {
-		templates: true,
-		sandbox: {
-			enabled: true,
-			modes: ["markdown", "specs"]
-		},
-		studio: {
-			enabled: true,
-			installable: true
-		},
-		mcp: { enabled: true }
-	}
+var example = defineExample({
+  meta: {
+    key: "project-management-sync",
+    version: "1.0.0",
+    title: "Project Management Sync",
+    description: "Create project-management work items in Linear, Jira Cloud, or Notion from a shared payload.",
+    kind: "integration",
+    visibility: "public",
+    stability: "experimental",
+    owners: ["@platform.integrations"],
+    tags: ["project-management", "linear", "jira", "notion", "integrations"]
+  },
+  docs: {
+    rootDocId: "docs.examples.project-management-sync",
+    usageDocId: "docs.examples.project-management-sync.usage"
+  },
+  entrypoints: {
+    packageName: "@contractspec/example.project-management-sync",
+    docs: "./docs"
+  },
+  surfaces: {
+    templates: true,
+    sandbox: { enabled: true, modes: ["markdown", "specs"] },
+    studio: { enabled: true, installable: true },
+    mcp: { enabled: true }
+  }
 });
-
-//#endregion
-export { example as default };
-//# sourceMappingURL=example.js.map
+var example_default = example;
+export {
+  example_default as default
+};

package/dist/index.d.ts

@@ -1,3 +1,4 @@
-import example from "./example.js";
-import { ProjectManagementProviderName, ProjectManagementSyncInput, ProjectManagementSyncOutput, buildSampleSummary, buildSampleWorkItems, createProviderFromEnv, resolveProviderName, runProjectManagementSyncFromEnv, syncProjectManagementWorkItems } from "./sync.js";
-export { ProjectManagementProviderName, ProjectManagementSyncInput, ProjectManagementSyncOutput, buildSampleSummary, buildSampleWorkItems, createProviderFromEnv, example, resolveProviderName, runProjectManagementSyncFromEnv, syncProjectManagementWorkItems };
+export * from './sync';
+export { default as example } from './example';
+import './docs';
+//# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,QAAQ,CAAC;AACvB,OAAO,EAAE,OAAO,IAAI,OAAO,EAAE,MAAM,WAAW,CAAC;AAC/C,OAAO,QAAQ,CAAC"}

package/dist/index.js

@@ -1,5 +1,195 @@
-import example from "./example.js";
-import { buildSampleSummary, buildSampleWorkItems, createProviderFromEnv, resolveProviderName, runProjectManagementSyncFromEnv, syncProjectManagementWorkItems } from "./sync.js";
-import "./docs/index.js";
+// @bun
+// src/docs/project-management-sync.docblock.ts
+import { registerDocBlocks } from "@contractspec/lib.contracts/docs";
+var blocks = [
+  {
+    id: "docs.examples.project-management-sync",
+    title: "Project Management Sync (example)",
+    summary: "Create a shared payload of work items and sync it to Linear, Jira Cloud, or Notion.",
+    kind: "reference",
+    visibility: "public",
+    route: "/docs/examples/project-management-sync",
+    tags: ["project-management", "linear", "jira", "notion", "example"],
+    body: `## What this example shows
+- Build a provider-agnostic payload of work items.
+- Resolve the target provider from environment variables.
+- Run in dry-run mode for preview output.
 
-export { buildSampleSummary, buildSampleWorkItems, createProviderFromEnv, example, resolveProviderName, runProjectManagementSyncFromEnv, syncProjectManagementWorkItems };
+## Guardrails
+- Keep secrets in env or secret providers only.
+- Use dry-run to validate payloads before writing.
+- Start with a small batch of tasks to validate setup.`
+  },
+  {
+    id: "docs.examples.project-management-sync.usage",
+    title: "Project Management Sync - Usage",
+    summary: "How to run the sync with env-driven provider settings.",
+    kind: "usage",
+    visibility: "public",
+    route: "/docs/examples/project-management-sync/usage",
+    tags: ["project-management", "usage"],
+    body: `## Usage
+- Set CONTRACTSPEC_PM_PROVIDER to linear, jira, or notion.
+- Set CONTRACTSPEC_PM_DRY_RUN=true to preview payloads.
+- Provide provider-specific env vars (API keys, project IDs).
+
+## Example
+- Call runProjectManagementSyncFromEnv() from sync.ts or import it in your app.
+- The helper builds a sample payload and calls the provider client.`
+  }
+];
+registerDocBlocks(blocks);
+// src/example.ts
+import { defineExample } from "@contractspec/lib.contracts";
+var example = defineExample({
+  meta: {
+    key: "project-management-sync",
+    version: "1.0.0",
+    title: "Project Management Sync",
+    description: "Create project-management work items in Linear, Jira Cloud, or Notion from a shared payload.",
+    kind: "integration",
+    visibility: "public",
+    stability: "experimental",
+    owners: ["@platform.integrations"],
+    tags: ["project-management", "linear", "jira", "notion", "integrations"]
+  },
+  docs: {
+    rootDocId: "docs.examples.project-management-sync",
+    usageDocId: "docs.examples.project-management-sync.usage"
+  },
+  entrypoints: {
+    packageName: "@contractspec/example.project-management-sync",
+    docs: "./docs"
+  },
+  surfaces: {
+    templates: true,
+    sandbox: { enabled: true, modes: ["markdown", "specs"] },
+    studio: { enabled: true, installable: true },
+    mcp: { enabled: true }
+  }
+});
+var example_default = example;
+
+// src/sync.ts
+import {
+  JiraProjectManagementProvider,
+  LinearProjectManagementProvider,
+  NotionProjectManagementProvider
+} from "@contractspec/integration.providers-impls/impls";
+async function syncProjectManagementWorkItems(input) {
+  const items = input.items ?? buildSampleWorkItems();
+  const summary = input.summary;
+  const dryRun = input.dryRun ?? false;
+  if (dryRun) {
+    return { summary, items };
+  }
+  const provider = input.providerClient ?? createProviderFromEnv(input.provider);
+  const createdSummary = summary ? await provider.createWorkItem(summary) : undefined;
+  const createdItems = await provider.createWorkItems(items);
+  return { summary: createdSummary, items: createdItems };
+}
+async function runProjectManagementSyncFromEnv() {
+  const provider = resolveProviderName();
+  const dryRun = process.env.CONTRACTSPEC_PM_DRY_RUN === "true";
+  const summary = provider === "notion" ? buildSampleSummary() : undefined;
+  return syncProjectManagementWorkItems({
+    provider,
+    summary,
+    dryRun
+  });
+}
+function buildSampleWorkItems() {
+  return [
+    {
+      title: "Review onboarding drop-off",
+      description: "Analyze activation funnel to identify the highest drop-off step and propose fixes.",
+      type: "task",
+      priority: "high",
+      tags: ["onboarding", "insights"]
+    },
+    {
+      title: "Ship first-run checklist",
+      description: "Create a guided checklist with 3-5 steps to help new users reach first value.",
+      type: "task",
+      priority: "medium",
+      tags: ["activation", "ux"],
+      dueDate: new Date("2026-02-15")
+    },
+    {
+      title: "Define success metrics",
+      description: "Agree on activation success metrics and instrument key events.",
+      type: "task",
+      priority: "low",
+      tags: ["analytics", "tracking"]
+    }
+  ];
+}
+function buildSampleSummary() {
+  return {
+    title: "Product Intent Summary",
+    description: "This summary aggregates the onboarding tasks and highlights the activation improvements to prioritize.",
+    type: "summary",
+    tags: ["product-intent", "summary"]
+  };
+}
+function createProviderFromEnv(provider) {
+  if (provider === "linear") {
+    return new LinearProjectManagementProvider({
+      apiKey: requireEnv("LINEAR_API_KEY"),
+      teamId: requireEnv("LINEAR_TEAM_ID"),
+      projectId: process.env.LINEAR_PROJECT_ID,
+      stateId: process.env.LINEAR_STATE_ID,
+      assigneeId: process.env.LINEAR_ASSIGNEE_ID,
+      labelIds: splitList(process.env.LINEAR_LABEL_IDS)
+    });
+  }
+  if (provider === "jira") {
+    return new JiraProjectManagementProvider({
+      siteUrl: requireEnv("JIRA_SITE_URL"),
+      email: requireEnv("JIRA_EMAIL"),
+      apiToken: requireEnv("JIRA_API_TOKEN"),
+      projectKey: process.env.JIRA_PROJECT_KEY,
+      issueType: process.env.JIRA_ISSUE_TYPE,
+      defaultLabels: splitList(process.env.JIRA_DEFAULT_LABELS)
+    });
+  }
+  return new NotionProjectManagementProvider({
+    apiKey: requireEnv("NOTION_API_KEY"),
+    databaseId: process.env.NOTION_DATABASE_ID,
+    summaryParentPageId: process.env.NOTION_SUMMARY_PARENT_PAGE_ID,
+    titleProperty: process.env.NOTION_TITLE_PROPERTY,
+    statusProperty: process.env.NOTION_STATUS_PROPERTY,
+    priorityProperty: process.env.NOTION_PRIORITY_PROPERTY,
+    tagsProperty: process.env.NOTION_TAGS_PROPERTY,
+    dueDateProperty: process.env.NOTION_DUE_DATE_PROPERTY,
+    descriptionProperty: process.env.NOTION_DESCRIPTION_PROPERTY
+  });
+}
+function resolveProviderName() {
+  const raw = (process.env.CONTRACTSPEC_PM_PROVIDER ?? "linear").toLowerCase();
+  if (raw === "linear" || raw === "jira" || raw === "notion")
+    return raw;
+  throw new Error(`Unsupported provider: ${raw}. Use one of: linear, jira, notion`);
+}
+function requireEnv(key) {
+  const value = process.env[key];
+  if (!value) {
+    throw new Error(`Missing required env var: ${key}`);
+  }
+  return value;
+}
+function splitList(value) {
+  if (!value)
+    return;
+  const items = value.split(",").map((item) => item.trim()).filter(Boolean);
+  return items.length > 0 ? items : undefined;
+}
+export {
+  syncProjectManagementWorkItems,
+  runProjectManagementSyncFromEnv,
+  resolveProviderName,
+  example_default as example,
+  createProviderFromEnv,
+  buildSampleWorkItems,
+  buildSampleSummary
+};

package/dist/node/docs/index.js

@@ -0,0 +1,40 @@
+// src/docs/project-management-sync.docblock.ts
+import { registerDocBlocks } from "@contractspec/lib.contracts/docs";
+var blocks = [
+  {
+    id: "docs.examples.project-management-sync",
+    title: "Project Management Sync (example)",
+    summary: "Create a shared payload of work items and sync it to Linear, Jira Cloud, or Notion.",
+    kind: "reference",
+    visibility: "public",
+    route: "/docs/examples/project-management-sync",
+    tags: ["project-management", "linear", "jira", "notion", "example"],
+    body: `## What this example shows
+- Build a provider-agnostic payload of work items.
+- Resolve the target provider from environment variables.
+- Run in dry-run mode for preview output.
+
+## Guardrails
+- Keep secrets in env or secret providers only.
+- Use dry-run to validate payloads before writing.
+- Start with a small batch of tasks to validate setup.`
+  },
+  {
+    id: "docs.examples.project-management-sync.usage",
+    title: "Project Management Sync - Usage",
+    summary: "How to run the sync with env-driven provider settings.",
+    kind: "usage",
+    visibility: "public",
+    route: "/docs/examples/project-management-sync/usage",
+    tags: ["project-management", "usage"],
+    body: `## Usage
+- Set CONTRACTSPEC_PM_PROVIDER to linear, jira, or notion.
+- Set CONTRACTSPEC_PM_DRY_RUN=true to preview payloads.
+- Provide provider-specific env vars (API keys, project IDs).
+
+## Example
+- Call runProjectManagementSyncFromEnv() from sync.ts or import it in your app.
+- The helper builds a sample payload and calls the provider client.`
+  }
+];
+registerDocBlocks(blocks);

package/dist/node/docs/project-management-sync.docblock.js

@@ -0,0 +1,40 @@
+// src/docs/project-management-sync.docblock.ts
+import { registerDocBlocks } from "@contractspec/lib.contracts/docs";
+var blocks = [
+  {
+    id: "docs.examples.project-management-sync",
+    title: "Project Management Sync (example)",
+    summary: "Create a shared payload of work items and sync it to Linear, Jira Cloud, or Notion.",
+    kind: "reference",
+    visibility: "public",
+    route: "/docs/examples/project-management-sync",
+    tags: ["project-management", "linear", "jira", "notion", "example"],
+    body: `## What this example shows
+- Build a provider-agnostic payload of work items.
+- Resolve the target provider from environment variables.
+- Run in dry-run mode for preview output.
+
+## Guardrails
+- Keep secrets in env or secret providers only.
+- Use dry-run to validate payloads before writing.
+- Start with a small batch of tasks to validate setup.`
+  },
+  {
+    id: "docs.examples.project-management-sync.usage",
+    title: "Project Management Sync - Usage",
+    summary: "How to run the sync with env-driven provider settings.",
+    kind: "usage",
+    visibility: "public",
+    route: "/docs/examples/project-management-sync/usage",
+    tags: ["project-management", "usage"],
+    body: `## Usage
+- Set CONTRACTSPEC_PM_PROVIDER to linear, jira, or notion.
+- Set CONTRACTSPEC_PM_DRY_RUN=true to preview payloads.
+- Provide provider-specific env vars (API keys, project IDs).
+
+## Example
+- Call runProjectManagementSyncFromEnv() from sync.ts or import it in your app.
+- The helper builds a sample payload and calls the provider client.`
+  }
+];
+registerDocBlocks(blocks);

package/dist/node/example.js

@@ -0,0 +1,33 @@
+// src/example.ts
+import { defineExample } from "@contractspec/lib.contracts";
+var example = defineExample({
+  meta: {
+    key: "project-management-sync",
+    version: "1.0.0",
+    title: "Project Management Sync",
+    description: "Create project-management work items in Linear, Jira Cloud, or Notion from a shared payload.",
+    kind: "integration",
+    visibility: "public",
+    stability: "experimental",
+    owners: ["@platform.integrations"],
+    tags: ["project-management", "linear", "jira", "notion", "integrations"]
+  },
+  docs: {
+    rootDocId: "docs.examples.project-management-sync",
+    usageDocId: "docs.examples.project-management-sync.usage"
+  },
+  entrypoints: {
+    packageName: "@contractspec/example.project-management-sync",
+    docs: "./docs"
+  },
+  surfaces: {
+    templates: true,
+    sandbox: { enabled: true, modes: ["markdown", "specs"] },
+    studio: { enabled: true, installable: true },
+    mcp: { enabled: true }
+  }
+});
+var example_default = example;
+export {
+  example_default as default
+};