@catafal/notion-cli 5.9.0

package/dist/commands/page/delete.d.ts

@@ -0,0 +1,36 @@
+import { Command } from '@oclif/core';
+/**
+ * Convenience alias for archiving (soft-deleting) a Notion page.
+ * Equivalent to: notion-cli page update PAGE_ID -a
+ *
+ * Notion API does not support hard deletes — archiving is the only delete operation.
+ */
+export default class PageDelete extends Command {
+    static description: string;
+    static aliases: string[];
+    static examples: {
+        description: string;
+        command: string;
+    }[];
+    static args: {
+        page_id: import("@oclif/core/lib/interfaces").Arg<string, Record<string, unknown>>;
+    };
+    static flags: {
+        json: import("@oclif/core/lib/interfaces").BooleanFlag<boolean>;
+        'page-size': import("@oclif/core/lib/interfaces").OptionFlag<number, import("@oclif/core/lib/interfaces").CustomOptions>;
+        retry: import("@oclif/core/lib/interfaces").BooleanFlag<boolean>;
+        timeout: import("@oclif/core/lib/interfaces").OptionFlag<number, import("@oclif/core/lib/interfaces").CustomOptions>;
+        'no-cache': import("@oclif/core/lib/interfaces").BooleanFlag<boolean>;
+        verbose: import("@oclif/core/lib/interfaces").BooleanFlag<boolean>;
+        minimal: import("@oclif/core/lib/interfaces").BooleanFlag<boolean>;
+        columns: import("@oclif/core/lib/interfaces").OptionFlag<string, import("@oclif/core/lib/interfaces").CustomOptions>;
+        sort: import("@oclif/core/lib/interfaces").OptionFlag<string, import("@oclif/core/lib/interfaces").CustomOptions>;
+        filter: import("@oclif/core/lib/interfaces").OptionFlag<string, import("@oclif/core/lib/interfaces").CustomOptions>;
+        csv: import("@oclif/core/lib/interfaces").BooleanFlag<boolean>;
+        extended: import("@oclif/core/lib/interfaces").BooleanFlag<boolean>;
+        'no-truncate': import("@oclif/core/lib/interfaces").BooleanFlag<boolean>;
+        'no-header': import("@oclif/core/lib/interfaces").BooleanFlag<boolean>;
+        raw: import("@oclif/core/lib/interfaces").BooleanFlag<boolean>;
+    };
+    run(): Promise<void>;
+}

package/dist/commands/page/delete.js

@@ -0,0 +1,107 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const core_1 = require("@oclif/core");
+const notion = require("../../notion");
+const helper_1 = require("../../helper");
+const notion_resolver_1 = require("../../utils/notion-resolver");
+const table_formatter_1 = require("../../utils/table-formatter");
+const base_flags_1 = require("../../base-flags");
+const errors_1 = require("../../errors");
+/**
+ * Convenience alias for archiving (soft-deleting) a Notion page.
+ * Equivalent to: notion-cli page update PAGE_ID -a
+ *
+ * Notion API does not support hard deletes — archiving is the only delete operation.
+ */
+class PageDelete extends core_1.Command {
+    async run() {
+        const { args, flags } = await this.parse(PageDelete);
+        try {
+            const pageId = await (0, notion_resolver_1.resolveNotionId)(args.page_id, 'page');
+            // Archive the page (Notion's soft-delete)
+            const res = await notion.updatePageProps({
+                page_id: pageId,
+                archived: true,
+            });
+            // JSON output for automation
+            if (flags.json) {
+                this.log(JSON.stringify({
+                    success: true,
+                    data: res,
+                    timestamp: new Date().toISOString()
+                }, null, 2));
+                process.exit(0);
+                return;
+            }
+            // Raw JSON output (legacy)
+            if (flags.raw) {
+                (0, helper_1.outputRawJson)(res);
+                process.exit(0);
+                return;
+            }
+            // Table output (default)
+            const columns = {
+                title: {
+                    get: (row) => (0, helper_1.getPageTitle)(row),
+                },
+                object: {},
+                id: {},
+                archived: {},
+                url: {},
+            };
+            const options = {
+                printLine: this.log.bind(this),
+                ...flags,
+            };
+            (0, table_formatter_1.formatTable)([res], columns, options);
+            process.exit(0);
+        }
+        catch (error) {
+            const cliError = error instanceof errors_1.NotionCLIError
+                ? error
+                : (0, errors_1.wrapNotionError)(error, {
+                    resourceType: 'page',
+                    attemptedId: args.page_id,
+                    endpoint: 'pages.update'
+                });
+            if (flags.json) {
+                this.log(JSON.stringify(cliError.toJSON(), null, 2));
+            }
+            else {
+                this.error(cliError.toHumanString());
+            }
+            process.exit(1);
+        }
+    }
+}
+PageDelete.description = 'Archive (soft-delete) a Notion page';
+PageDelete.aliases = ['page:d'];
+PageDelete.examples = [
+    {
+        description: 'Delete (archive) a page by ID',
+        command: '$ notion-cli page delete PAGE_ID',
+    },
+    {
+        description: 'Delete (archive) a page by URL',
+        command: '$ notion-cli page delete https://notion.so/PAGE_ID',
+    },
+    {
+        description: 'Delete and output JSON for automation',
+        command: '$ notion-cli page delete PAGE_ID --json',
+    },
+];
+PageDelete.args = {
+    page_id: core_1.Args.string({
+        required: true,
+        description: 'Page ID or full Notion URL',
+    }),
+};
+PageDelete.flags = {
+    raw: core_1.Flags.boolean({
+        char: 'r',
+        description: 'Output raw JSON',
+    }),
+    ...table_formatter_1.tableFlags,
+    ...base_flags_1.AutomationFlags,
+};
+exports.default = PageDelete;

package/dist/commands/page/export.d.ts

@@ -0,0 +1,38 @@
+import { Command } from '@oclif/core';
+/**
+ * Export a Notion page to a local file (markdown or JSON).
+ *
+ * This is the reverse of `page create -f`: instead of reading a local file
+ * and pushing it to Notion, it pulls a Notion page and writes it locally.
+ *
+ * Markdown is the default format because it's human-readable and round-trips
+ * well with `page create -f`. JSON is available via --json for automation
+ * or lossless backups.
+ */
+export default class PageExport extends Command {
+    static description: string;
+    static aliases: string[];
+    static examples: {
+        description: string;
+        command: string;
+    }[];
+    static args: {
+        page_id: import("@oclif/core/lib/interfaces").Arg<string, Record<string, unknown>>;
+    };
+    static flags: {
+        json: import("@oclif/core/lib/interfaces").BooleanFlag<boolean>;
+        'page-size': import("@oclif/core/lib/interfaces").OptionFlag<number, import("@oclif/core/lib/interfaces").CustomOptions>;
+        retry: import("@oclif/core/lib/interfaces").BooleanFlag<boolean>;
+        timeout: import("@oclif/core/lib/interfaces").OptionFlag<number, import("@oclif/core/lib/interfaces").CustomOptions>;
+        'no-cache': import("@oclif/core/lib/interfaces").BooleanFlag<boolean>;
+        verbose: import("@oclif/core/lib/interfaces").BooleanFlag<boolean>;
+        minimal: import("@oclif/core/lib/interfaces").BooleanFlag<boolean>;
+        output: import("@oclif/core/lib/interfaces").OptionFlag<string, import("@oclif/core/lib/interfaces").CustomOptions>;
+    };
+    run(): Promise<void>;
+    /**
+     * Validate output path to prevent directory traversal attacks.
+     * Ensures the resolved path stays within the current working directory.
+     */
+    private validateOutputPath;
+}

package/dist/commands/page/export.js

@@ -0,0 +1,120 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const core_1 = require("@oclif/core");
+const fs = require("fs");
+const path = require("path");
+const notion = require("../../notion");
+const notion_to_md_1 = require("notion-to-md");
+const notion_resolver_1 = require("../../utils/notion-resolver");
+const helper_1 = require("../../helper");
+const base_flags_1 = require("../../base-flags");
+const errors_1 = require("../../errors");
+/**
+ * Export a Notion page to a local file (markdown or JSON).
+ *
+ * This is the reverse of `page create -f`: instead of reading a local file
+ * and pushing it to Notion, it pulls a Notion page and writes it locally.
+ *
+ * Markdown is the default format because it's human-readable and round-trips
+ * well with `page create -f`. JSON is available via --json for automation
+ * or lossless backups.
+ */
+class PageExport extends core_1.Command {
+    async run() {
+        const { args, flags } = await this.parse(PageExport);
+        try {
+            const pageId = await (0, notion_resolver_1.resolveNotionId)(args.page_id, 'page');
+            // Choose format: JSON for structured data, markdown for human-readable
+            let content;
+            if (flags.json) {
+                let page = await notion.retrievePage({ page_id: pageId });
+                if (flags.minimal) {
+                    page = (0, helper_1.stripMetadata)(page);
+                }
+                content = JSON.stringify(page, null, 2);
+            }
+            else {
+                // notion-to-md handles all block fetching and conversion internally
+                const n2m = new notion_to_md_1.NotionToMarkdown({ notionClient: notion.client });
+                const mdBlocks = await n2m.pageToMarkdown(pageId);
+                content = n2m.toMarkdownString(mdBlocks).parent;
+            }
+            // Write to file or stdout
+            if (flags.output) {
+                const resolvedPath = this.validateOutputPath(flags.output);
+                fs.writeFileSync(resolvedPath, content, 'utf-8');
+                this.log(`Exported to ${flags.output}`);
+            }
+            else {
+                this.log(content);
+            }
+            process.exit(0);
+        }
+        catch (error) {
+            const cliError = error instanceof errors_1.NotionCLIError
+                ? error
+                : (0, errors_1.wrapNotionError)(error, {
+                    resourceType: 'page',
+                    attemptedId: args.page_id,
+                    endpoint: 'page.export'
+                });
+            if (flags.json) {
+                this.log(JSON.stringify(cliError.toJSON(), null, 2));
+            }
+            else {
+                this.error(cliError.toHumanString());
+            }
+            process.exit(1);
+        }
+    }
+    /**
+     * Validate output path to prevent directory traversal attacks.
+     * Ensures the resolved path stays within the current working directory.
+     */
+    validateOutputPath(filePath) {
+        const basePath = path.resolve('./');
+        const resolved = path.resolve(basePath, filePath);
+        if (!resolved.startsWith(basePath)) {
+            throw new errors_1.NotionCLIError('VALIDATION_ERROR', 'Invalid output path: must be within current directory', [{ description: 'Use a relative path', command: 'notion-cli page export PAGE_ID -o ./output.md' }]);
+        }
+        return resolved;
+    }
+}
+PageExport.description = 'Export a Notion page to markdown or JSON';
+PageExport.aliases = ['page:e'];
+PageExport.examples = [
+    {
+        description: 'Export page as markdown to stdout',
+        command: '$ notion-cli page export PAGE_ID',
+    },
+    {
+        description: 'Export page as markdown to a file',
+        command: '$ notion-cli page export PAGE_ID -o notes.md',
+    },
+    {
+        description: 'Export page as JSON to a file',
+        command: '$ notion-cli page export PAGE_ID --json -o page.json',
+    },
+    {
+        description: 'Export using a Notion URL',
+        command: '$ notion-cli page export "https://notion.so/My-Page-abc123" -o notes.md',
+    },
+    {
+        description: 'Pipe markdown to another command',
+        command: '$ notion-cli page export PAGE_ID | head -20',
+    },
+];
+PageExport.args = {
+    page_id: core_1.Args.string({
+        required: true,
+        description: 'Page ID or full Notion URL',
+    }),
+};
+PageExport.flags = {
+    output: core_1.Flags.string({
+        char: 'o',
+        description: 'File path to write (omit for stdout)',
+    }),
+    ...base_flags_1.AutomationFlags,
+};
+exports.default = PageExport;

package/dist/commands/page/retrieve/property_item.d.ts

@@ -0,0 +1,24 @@
+import { Command } from '@oclif/core';
+export default class PageRetrievePropertyItem extends Command {
+    static description: string;
+    static aliases: string[];
+    static examples: {
+        description: string;
+        command: string;
+    }[];
+    static args: {
+        page_id: import("@oclif/core/lib/interfaces").Arg<string, Record<string, unknown>>;
+        property_id: import("@oclif/core/lib/interfaces").Arg<string, Record<string, unknown>>;
+    };
+    static flags: {
+        json: import("@oclif/core/lib/interfaces").BooleanFlag<boolean>;
+        'page-size': import("@oclif/core/lib/interfaces").OptionFlag<number, import("@oclif/core/lib/interfaces").CustomOptions>;
+        retry: import("@oclif/core/lib/interfaces").BooleanFlag<boolean>;
+        timeout: import("@oclif/core/lib/interfaces").OptionFlag<number, import("@oclif/core/lib/interfaces").CustomOptions>;
+        'no-cache': import("@oclif/core/lib/interfaces").BooleanFlag<boolean>;
+        verbose: import("@oclif/core/lib/interfaces").BooleanFlag<boolean>;
+        minimal: import("@oclif/core/lib/interfaces").BooleanFlag<boolean>;
+        raw: import("@oclif/core/lib/interfaces").BooleanFlag<boolean>;
+    };
+    run(): Promise<void>;
+}

package/dist/commands/page/retrieve/property_item.js

@@ -0,0 +1,75 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const core_1 = require("@oclif/core");
+const notion = require("../../../notion");
+const helper_1 = require("../../../helper");
+const base_flags_1 = require("../../../base-flags");
+const errors_1 = require("../../../errors");
+const notion_resolver_1 = require("../../../utils/notion-resolver");
+class PageRetrievePropertyItem extends core_1.Command {
+    async run() {
+        const { args, flags } = await this.parse(PageRetrievePropertyItem);
+        try {
+            // Resolve URL/name/ID to clean Notion ID (property_id stays raw — it's a schema key, not a Notion resource)
+            const pageId = await (0, notion_resolver_1.resolveNotionId)(args.page_id, 'page');
+            const res = await notion.retrievePageProperty(pageId, args.property_id);
+            // Handle JSON output for automation
+            if (flags.json) {
+                this.log(JSON.stringify({
+                    success: true,
+                    data: res,
+                    timestamp: new Date().toISOString()
+                }, null, 2));
+                process.exit(0);
+                return;
+            }
+            // Handle raw JSON output (default for this command)
+            (0, helper_1.outputRawJson)(res);
+            process.exit(0);
+        }
+        catch (error) {
+            const cliError = error instanceof errors_1.NotionCLIError
+                ? error
+                : (0, errors_1.wrapNotionError)(error, {
+                    resourceType: 'page',
+                    attemptedId: args.page_id,
+                    endpoint: 'pages.properties.retrieve'
+                });
+            if (flags.json) {
+                this.log(JSON.stringify(cliError.toJSON(), null, 2));
+            }
+            else {
+                this.error(cliError.toHumanString());
+            }
+            process.exit(1);
+        }
+    }
+}
+PageRetrievePropertyItem.description = 'Retrieve a page property item';
+PageRetrievePropertyItem.aliases = ['page:r:pi'];
+PageRetrievePropertyItem.examples = [
+    {
+        description: 'Retrieve a page property item',
+        command: `$ notion-cli page retrieve:property_item PAGE_ID PROPERTY_ID`,
+    },
+    {
+        description: 'Retrieve a page property item and output raw json',
+        command: `$ notion-cli page retrieve:property_item PAGE_ID PROPERTY_ID -r`,
+    },
+    {
+        description: 'Retrieve a page property item and output JSON for automation',
+        command: `$ notion-cli page retrieve:property_item PAGE_ID PROPERTY_ID --json`,
+    },
+];
+PageRetrievePropertyItem.args = {
+    page_id: core_1.Args.string({ required: true }),
+    property_id: core_1.Args.string({ required: true }),
+};
+PageRetrievePropertyItem.flags = {
+    raw: core_1.Flags.boolean({
+        char: 'r',
+        description: 'output raw json',
+    }),
+    ...base_flags_1.AutomationFlags,
+};
+exports.default = PageRetrievePropertyItem;

package/dist/commands/page/retrieve.d.ts

@@ -0,0 +1,36 @@
+import { Command } from '@oclif/core';
+export default class PageRetrieve extends Command {
+    static description: string;
+    static aliases: string[];
+    static examples: {
+        description: string;
+        command: string;
+    }[];
+    static args: {
+        page_id: import("@oclif/core/lib/interfaces").Arg<string, Record<string, unknown>>;
+    };
+    static flags: {
+        json: import("@oclif/core/lib/interfaces").BooleanFlag<boolean>;
+        'page-size': import("@oclif/core/lib/interfaces").OptionFlag<number, import("@oclif/core/lib/interfaces").CustomOptions>;
+        retry: import("@oclif/core/lib/interfaces").BooleanFlag<boolean>;
+        timeout: import("@oclif/core/lib/interfaces").OptionFlag<number, import("@oclif/core/lib/interfaces").CustomOptions>;
+        'no-cache': import("@oclif/core/lib/interfaces").BooleanFlag<boolean>;
+        verbose: import("@oclif/core/lib/interfaces").BooleanFlag<boolean>;
+        minimal: import("@oclif/core/lib/interfaces").BooleanFlag<boolean>;
+        markdown: import("@oclif/core/lib/interfaces").BooleanFlag<boolean>;
+        'compact-json': import("@oclif/core/lib/interfaces").BooleanFlag<boolean>;
+        pretty: import("@oclif/core/lib/interfaces").BooleanFlag<boolean>;
+        columns: import("@oclif/core/lib/interfaces").OptionFlag<string, import("@oclif/core/lib/interfaces").CustomOptions>;
+        sort: import("@oclif/core/lib/interfaces").OptionFlag<string, import("@oclif/core/lib/interfaces").CustomOptions>;
+        filter: import("@oclif/core/lib/interfaces").OptionFlag<string, import("@oclif/core/lib/interfaces").CustomOptions>;
+        csv: import("@oclif/core/lib/interfaces").BooleanFlag<boolean>;
+        extended: import("@oclif/core/lib/interfaces").BooleanFlag<boolean>;
+        'no-truncate': import("@oclif/core/lib/interfaces").BooleanFlag<boolean>;
+        'no-header': import("@oclif/core/lib/interfaces").BooleanFlag<boolean>;
+        raw: import("@oclif/core/lib/interfaces").BooleanFlag<boolean>;
+        map: import("@oclif/core/lib/interfaces").BooleanFlag<boolean>;
+        recursive: import("@oclif/core/lib/interfaces").BooleanFlag<boolean>;
+        'max-depth': import("@oclif/core/lib/interfaces").OptionFlag<number, import("@oclif/core/lib/interfaces").CustomOptions>;
+    };
+    run(): Promise<void>;
+}