@notionhq/apps 0.0.41 → 0.0.42

package/dist/cli/build.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"build.d.ts","sourceRoot":"","sources":["../../src/cli/build.ts"],"names":[],"mappings":"AAKA,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,gBAAgB,CAAC;AAUlD,MAAM,MAAM,WAAW,GAAG;IACzB,QAAQ,EAAE,WAAW,CAAC;IACtB,UAAU,EAAE,MAAM,CAAC;IACnB,YAAY,EAAE,MAAM,CAAC;CACrB,CAAC;AAEF;;;;GAIG;AACH,wBAAsB,QAAQ,CAAC,WAAW,EAAE,MAAM,GAAG,OAAO,CAAC,WAAW,CAAC,CA2CxE"}
+{"version":3,"file":"build.d.ts","sourceRoot":"","sources":["../../src/cli/build.ts"],"names":[],"mappings":"AAKA,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,gBAAgB,CAAC;AAalD,MAAM,MAAM,WAAW,GAAG;IACzB,QAAQ,EAAE,WAAW,CAAC;IACtB,UAAU,EAAE,MAAM,CAAC;IACnB,YAAY,EAAE,MAAM,CAAC;CACrB,CAAC;AAEF;;;;GAIG;AACH,wBAAsB,QAAQ,CAAC,WAAW,EAAE,MAAM,GAAG,OAAO,CAAC,WAAW,CAAC,CA2CxE"}

package/dist/cli/build.js

@@ -1,6 +1,7 @@
 import * as fs from "node:fs";
 import * as path from "node:path";
 import { rolldown } from "rolldown";
+import { APPS_WORKSPACE_RESOURCE_ID } from "../notion-as-code/intents.js";
 import {
   createProvisioningArtifact
 } from "../notion-as-code/provisioning.js";
@@ -8,6 +9,7 @@ import { clearRegisteredPacers } from "../pacer.js";
 import { generateEntry, generateMetadataEntry, generateBlocksEntry } from "./codegen.js";
 import { discoverCapabilities } from "./discover.js";
 import { extractManifest, extractProvisioning, extractBlockConfigs } from "./emit-manifest.js";
+const APP_MD_RESOURCE_ID = "__notion_apps_app_md__";
 async function buildApp(projectRoot) {
   const capabilities = await discoverCapabilities(projectRoot);
   if (capabilities.length === 0) {
@@ -45,14 +47,36 @@ async function buildApp(projectRoot) {
 }
 async function emitProvisioningArtifact(projectRoot, entityProvisioning) {
   const provisioningPath = path.join(projectRoot, "dist", "provisioning.json");
-  if (entityProvisioning.intents.length === 0) {
+  const appPage = await readAppPage(projectRoot);
+  if (entityProvisioning.intents.length === 0 && !appPage) {
     await fs.promises.rm(provisioningPath, { force: true });
     return;
   }
-  const artifact = createProvisioningArtifact(entityProvisioning.intents);
+  const artifact = createProvisioningArtifact([
+    ...entityProvisioning.intents,
+    ...appPage ? [appPage] : []
+  ]);
   await fs.promises.writeFile(provisioningPath, `${JSON.stringify(artifact, null, "	")}
 `);
 }
+async function readAppPage(projectRoot) {
+  let content;
+  try {
+    content = await fs.promises.readFile(path.join(projectRoot, "APP.md"), "utf8");
+  } catch (error) {
+    if (error.code === "ENOENT") {
+      return void 0;
+    }
+    throw error;
+  }
+  return {
+    type: "page",
+    resourceId: APP_MD_RESOURCE_ID,
+    parent: { type: "resourceId", resourceId: APPS_WORKSPACE_RESOURCE_ID },
+    properties: { title: [["APP.md"]] },
+    content
+  };
+}
 async function buildMetadata(projectRoot, capabilities) {
   const metadataEntryPath = path.join(projectRoot, ".notion", "metadata-entry.ts");
   const metadataBundlePath = path.join(projectRoot, ".notion", "metadata.js");

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@notionhq/apps",
-	"version": "0.0.41",
+	"version": "0.0.42",
 	"description": "An SDK for building workflow apps for Notion",
 	"license": "MIT",
 	"bin": {

package/src/cli/build.test.ts

@@ -456,6 +456,43 @@ describe("buildApp", () => {
 		});
 	});
 
+	it("emits APP.md as a private page with stable identity and resource references", async () => {
+		const root = await fs.promises.mkdtemp(path.join(FIXTURES, "app-md-"));
+		try {
+			await fs.promises.cp(
+				path.join(FIXTURES, "notion-as-code", "src"),
+				path.join(root, "src"),
+				{
+					recursive: true,
+				},
+			);
+			const markdown =
+				'# App guide\n\nSee <mention-page url="{{github-app-private-page}}">Home</mention-page>.\n';
+			await fs.promises.writeFile(path.join(root, "APP.md"), markdown);
+			await buildApp(root);
+			const provisioningPath = path.join(root, "dist", "provisioning.json");
+			const provisioning = JSON.parse(await fs.promises.readFile(provisioningPath, "utf8"));
+			expect(provisioning.intents.at(-1)).toEqual({
+				type: "page",
+				resourceId: "__notion_apps_app_md__",
+				parent: { type: "resourceId", resourceId: "__notion_apps_workspace__" },
+				properties: { title: [["APP.md"]] },
+				content: markdown,
+			});
+
+			await fs.promises.rm(path.join(root, "APP.md"));
+			await buildApp(root);
+			const withoutAppPage = JSON.parse(await fs.promises.readFile(provisioningPath, "utf8"));
+			expect(withoutAppPage.intents).not.toEqual(
+				expect.arrayContaining([
+					expect.objectContaining({ resourceId: "__notion_apps_app_md__" }),
+				]),
+			);
+		} finally {
+			await fs.promises.rm(root, { recursive: true, force: true });
+		}
+	});
+
 	it("removes provisioning when a rebuild no longer declares Notion resources", async () => {
 		const root = await fs.promises.mkdtemp(path.join(FIXTURES, "provisioning-rebuild-"));
 		try {

package/src/cli/build.ts

@@ -4,6 +4,7 @@ import * as path from "node:path";
 import { rolldown } from "rolldown";
 
 import type { AppManifest } from "../manifest.js";
+import { APPS_WORKSPACE_RESOURCE_ID, type PageIntent } from "../notion-as-code/intents.js";
 import {
 	createProvisioningArtifact,
 	type RecordedProvisioning,
@@ -13,6 +14,8 @@ import { generateEntry, generateMetadataEntry, generateBlocksEntry } from "./cod
 import { discoverCapabilities, type DiscoveredCapability } from "./discover.js";
 import { extractManifest, extractProvisioning, extractBlockConfigs } from "./emit-manifest.js";
 
+const APP_MD_RESOURCE_ID = "__notion_apps_app_md__";
+
 export type BuildResult = {
 	manifest: AppManifest;
 	bundlePath: string;
@@ -75,15 +78,40 @@ async function emitProvisioningArtifact(
 	entityProvisioning: RecordedProvisioning,
 ): Promise<void> {
 	const provisioningPath = path.join(projectRoot, "dist", "provisioning.json");
-	if (entityProvisioning.intents.length === 0) {
+	const appPage = await readAppPage(projectRoot);
+	if (entityProvisioning.intents.length === 0 && !appPage) {
 		await fs.promises.rm(provisioningPath, { force: true });
 		return;
 	}
 
-	const artifact = createProvisioningArtifact(entityProvisioning.intents);
+	const artifact = createProvisioningArtifact([
+		...entityProvisioning.intents,
+		...(appPage ? [appPage] : []),
+	]);
 	await fs.promises.writeFile(provisioningPath, `${JSON.stringify(artifact, null, "\t")}\n`);
 }
 
+async function readAppPage(
+	projectRoot: string,
+): Promise<({ type: "page" } & PageIntent) | undefined> {
+	let content: string;
+	try {
+		content = await fs.promises.readFile(path.join(projectRoot, "APP.md"), "utf8");
+	} catch (error) {
+		if ((error as NodeJS.ErrnoException).code === "ENOENT") {
+			return undefined;
+		}
+		throw error;
+	}
+	return {
+		type: "page",
+		resourceId: APP_MD_RESOURCE_ID,
+		parent: { type: "resourceId", resourceId: APPS_WORKSPACE_RESOURCE_ID },
+		properties: { title: [["APP.md"]] },
+		content,
+	};
+}
+
 /** Bundle capabilities separately to record their Notion-as-Code declarations without shipping them. */
 async function buildMetadata(
 	projectRoot: string,