outrank-cli 0.7.1 → 0.9.0

package/src/commands/products/index.js

@@ -1,5 +1,6 @@
 import { defineGroup } from '../registry.js';
 import { backlinksGroup } from './backlinks.js';
+import { blogGroup } from './blog.js';
 import {
   competitorsGroup,
   outputSettingsGroup,
@@ -78,6 +79,10 @@ export const PRODUCTS_HELP = `Usage:
   outrank-cli products backlinks reverify <product-id> <backlink-id>
   outrank-cli products backlinks subscription <product-id>
   outrank-cli products backlinks subscribe-quote <product-id> --plan premium|enterprise
+  outrank-cli products blog get <product-id>
+  outrank-cli products blog create <product-id> [--json <object>]
+  outrank-cli products blog posts list <product-id>
+  outrank-cli products blog --help   (design, domain, posts, pages, categories, authors, redirects, snippets, subscribers, webhooks)
 
 JSON Input:
   Use one of: --json '<object>', --json-file payload.json, or --json-stdin
@@ -142,6 +147,8 @@ Examples:
   outrank-cli products backlinks reverify 00000000-0000-0000-0000-000000000000 11111111-1111-1111-1111-111111111111
   outrank-cli products backlinks subscription 00000000-0000-0000-0000-000000000000
   outrank-cli products backlinks subscribe-quote 00000000-0000-0000-0000-000000000000 --plan premium
+  outrank-cli products blog create 00000000-0000-0000-0000-000000000000 --json '{"subdomain":"acme","template":"editorial","accentColor":"#2563EB"}'
+  outrank-cli products blog posts update-content 00000000-0000-0000-0000-000000000000 11111111-1111-1111-1111-111111111111 --json-file post.json
 `;
 
 export const productsGroup = defineGroup({
@@ -150,7 +157,7 @@ export const productsGroup = defineGroup({
     usage: PRODUCTS_HELP,
     guidance:
       'Choose one of: list, get, create, update, pause, resume, integrations, output-settings, target-audiences, ' +
-      'competitors, gsc, linking, backlinks.',
+      'competitors, gsc, linking, backlinks, blog.',
   },
   unknown: (word) => ({
     message: `Unknown products subcommand: ${word}.`,
@@ -170,5 +177,6 @@ export const productsGroup = defineGroup({
     gscGroup,
     linkingGroup,
     backlinksGroup,
+    blogGroup,
   ],
 });

package/src/commands/registry.js

@@ -22,6 +22,7 @@ export const Toolset = Object.freeze({
   MARKETPLACE_SELLER: 'marketplace-seller',
   MARKETPLACE_BUYER: 'marketplace-buyer',
   BILLING: 'billing',
+  BLOG: 'blog',
 });
 
 export const BodyMode = Object.freeze({

package/src/core/constants.js

@@ -27,6 +27,8 @@ export const MCP_STARTUP_RESOLVE_TIMEOUT_MS = 3_000;
 
 export const MAX_IMAGE_UPLOAD_MEGABYTES = 5;
 export const MAX_IMAGE_UPLOAD_BYTES = MAX_IMAGE_UPLOAD_MEGABYTES * BYTES_PER_MB;
+export const MAX_TEXT_FILE_MEGABYTES = 1;
+export const MAX_TEXT_FILE_BYTES = MAX_TEXT_FILE_MEGABYTES * BYTES_PER_MB;
 export const MAX_UPSTREAM_ERROR_BODY_CHARS = 500;
 export const MAX_RATE_LIMIT_HEADER_LENGTH = 64;
 export const MAX_TOOL_NAME_LENGTH = 46;
@@ -45,6 +47,25 @@ export const GSC_SEARCH_ANALYTICS_MAX_LIMIT = 1000;
 export const KEYWORDS_GENERATE_MIN_COUNT = 5;
 export const KEYWORDS_GENERATE_MAX_COUNT = 30;
 
+export const BLOG_LIST_MIN_PAGE = 1;
+export const BLOG_TEMPLATES = Object.freeze(['classic', 'editorial', 'journal', 'studio', 'minimal']);
+export const BLOG_ANALYTICS_RANGES = Object.freeze(['7d', '30d', '90d']);
+export const BLOG_DOMAIN_MODES = Object.freeze(['subdomain', 'apex', 'subfolder']);
+export const BLOG_POST_LIST_STATUSES = Object.freeze(['all', 'published', 'scheduled', 'draft']);
+export const BLOG_POST_WRITE_STATUSES = Object.freeze(['draft', 'published', 'scheduled']);
+export const BLOG_SUBSCRIBER_STATUSES = Object.freeze(['subscribed', 'unsubscribed']);
+export const BLOG_PREVIEW_DESIGN_SCOPE = 'design';
+export const BLOG_PREVIEW_SCOPES = Object.freeze([BLOG_PREVIEW_DESIGN_SCOPE, 'post', 'page']);
+export const BLOG_PAGE_STATUSES = Object.freeze(['draft', 'published']);
+export const BLOG_PAGE_LAYOUTS = Object.freeze(['default', 'wide']);
+export const BLOG_SNIPPET_KINDS = Object.freeze(['cta', 'html', 'newsletter']);
+export const BLOG_SNIPPET_KINDS_WITH_REQUIRED_CONTENT = Object.freeze(['cta', 'html']);
+export const BLOG_POSITION_MAX = 10_000;
+export const BLOG_MAX_POSITIONS_PER_REQUEST = 100;
+export const BLOG_REDIRECT_GONE_STATUS_CODE = 410;
+export const BLOG_REDIRECT_STATUS_CODES = Object.freeze([301, 302, BLOG_REDIRECT_GONE_STATUS_CODE]);
+export const BLOG_WEBHOOK_EVENTS = Object.freeze(['subscriber.created']);
+
 export const BILLING_MIN_ADDITIONAL_PRODUCTS = 1;
 export const BILLING_MAX_ADDITIONAL_PRODUCTS = 30;
 export const BILLING_MIN_CONFIRM_CHARGE_CENTS = 0;

package/src/core/files.js

@@ -1,7 +1,7 @@
 import fs from 'node:fs/promises';
 import path from 'node:path';
 
-import { MAX_IMAGE_UPLOAD_BYTES } from './constants.js';
+import { MAX_IMAGE_UPLOAD_BYTES, MAX_TEXT_FILE_BYTES } from './constants.js';
 import { usageError } from './errors.js';
 
 const ImageMime = Object.freeze({
@@ -184,3 +184,39 @@ export const readImageUpload = async ({ filePath, allowedDir }) => {
 
   return toUpload(buffer, fileName);
 };
+
+const UTF8_ENCODING = 'utf-8';
+const BYTE_ORDER_MARK = '\uFEFF';
+const LINE_BREAK_PATTERN = /\r\n?/g;
+const LINE_FEED = '\n';
+const TEXT_OVERSIZE_GUIDANCE = 'Split the content or shorten it below the limit, then retry.';
+const TEXT_ENCODING_GUIDANCE = 'Save the file as UTF-8 text, then retry.';
+
+export const readTextFile = async ({ filePath, option }) => {
+  if (typeof filePath !== 'string' || filePath === '') {
+    throw usageError(`Missing required option: ${option} <path>.`, `Pass a local file path with \`${option} <path>\`.`);
+  }
+  let buffer;
+  try {
+    const stats = await fs.stat(filePath);
+    if (!stats.isFile()) throw usageError(`Not a file: ${filePath}`, readGuidance(filePath));
+    if (stats.size > MAX_TEXT_FILE_BYTES) {
+      throw usageError(
+        `${filePath} is ${stats.size} bytes; the maximum is ${MAX_TEXT_FILE_BYTES} bytes.`,
+        TEXT_OVERSIZE_GUIDANCE,
+      );
+    }
+    buffer = await fs.readFile(filePath);
+  } catch (error) {
+    if (error?.cliCode) throw error;
+    throw usageError(`Failed to read file: ${error.message}`, readGuidance(filePath));
+  }
+  let text;
+  try {
+    text = new TextDecoder(UTF8_ENCODING, { fatal: true }).decode(buffer);
+  } catch {
+    throw usageError(`${filePath} is not valid UTF-8 text.`, TEXT_ENCODING_GUIDANCE);
+  }
+  const withoutBom = text.startsWith(BYTE_ORDER_MARK) ? text.slice(BYTE_ORDER_MARK.length) : text;
+  return withoutBom.replace(LINE_BREAK_PATTERN, LINE_FEED);
+};

package/src/core/schema.js

@@ -11,6 +11,7 @@ export const FieldKind = Object.freeze({
   OBJECT: 'object',
   JSON: 'json',
   IMAGE: 'image',
+  TEXT_FILE: 'text-file',
 });
 
 export const BoolSerialize = Object.freeze({
@@ -63,6 +64,7 @@ export const list = ({ split = DEFAULT_LIST_SEPARATOR, serialize = ListSerialize
 export const object = () => createField(FieldKind.OBJECT, { properties: undefined });
 export const json = () => createField(FieldKind.JSON);
 export const image = () => createField(FieldKind.IMAGE);
+export const textFile = () => createField(FieldKind.TEXT_FILE);
 
 export const isField = (value) => Boolean(value) && Object.values(FieldKind).includes(value.kind);
 
@@ -124,6 +126,10 @@ const parseScalar = (field, value, label) => {
     if (!valid) throw usageError(`${label} must be an image upload (file_base64, file_name, file_type).`);
     return value;
   }
+  if (field.kind === FieldKind.TEXT_FILE) {
+    if (typeof value !== 'string') throw usageError(`${label} must be the path of a text file.`);
+    return value;
+  }
   throw new Error(`Unknown field kind: ${field.kind}`);
 };
 
@@ -254,6 +260,7 @@ const zodScalar = (z, field, options = {}) => {
   if (field.kind === FieldKind.IMAGE) {
     return z.object({ file_base64: z.string().min(1), file_name: z.string().min(1), file_type: z.string().min(1) });
   }
+  if (field.kind === FieldKind.TEXT_FILE) return z.string();
   throw new Error(`Unknown field kind: ${field.kind}`);
 };