@openemail/cli 0.0.1 → 0.0.2

package/openemail.js

@@ -344,7 +344,8 @@ const CLI_CALLBACK = {
     APP_PATH: '/cli/callback',
     LOOPBACK_PATH: '/callback',
     LOOPBACK_HOST: '127.0.0.1',
-    PASTE_SEPARATOR: '.'};
+    PASTE_SEPARATOR: '.'
+};
 const OAUTH_PARAMS = {
     RESPONSE_TYPE: 'response_type',
     CLIENT_ID: 'client_id',
@@ -672,7 +673,7 @@ const AUTH_MESSAGES = {
         : `OpenEmail could not refresh your sign-in (status ${status}). Try again shortly.`,
     SESSION_EXPIRED_PROFILE_NEXT: (name) => `Run \`openemail login --profile ${name}\` again.`,
     SERVER_SAID: (reason) => `The server said: ${reason}`,
-    CLIENT_NAME: (host) => `OpenEmail CLI on ${host}`,
+    CLIENT_NAME: (host) => `${OAUTH_CLIENT.NAME_PREFIX}${host}`,
     WHO_WORKSPACE: (workspace) => `workspace ${workspace}`,
     WHO_KEY: (keyId) => `key ${keyId}`,
     KEY_STAYS_VALID: (keyId) => `The key itself still works. Revoke it with \`openemail keys revoke ${keyId}\` if you no longer need it.`,
@@ -818,7 +819,6 @@ const DOCS_CHAT = {
 };
 const DOCS_PATHS = {
     DOCS: '/docs',
-    DOCS_PREFIX: 'docs/',
     MARKDOWN_EXTENSION: '.md',
     INDEX: '/llms.txt',
     ANCHOR: '#',
@@ -829,7 +829,8 @@ const DOCS_PATTERNS = {
     LEADING_SLASHES: /^\/+/,
     TRAILING_SLASHES: /\/+$/,
     LINE_BREAK: /\r?\n/,
-    DOT_SEGMENT: /^\.{1,2}$/
+    DOT_SEGMENT: /^\.{1,2}$/,
+    DOCS_PREFIX: /^(?:[a-z]{2}\/)?docs(?:\/|$)/i
 };
 const DOCS_FETCH = {
     ACCEPT: 'text/markdown, text/plain;q=0.9',
@@ -1111,7 +1112,7 @@ const BOOLEAN_TRUE_WORDS = new Set(['true', '1', 'yes', 'on']);
 const BOOLEAN_FALSE_WORDS = new Set(['false', '0', 'no', 'off']);
 const NEGATIVE_NUMBER_PATTERN = /^-\d+(\.\d+)?$/;
 
-var version$1 = "0.0.1";
+var version$1 = "0.0.2";
 
 const VERSION$1 = version$1;
 const CLI_NAME = 'openemail';
@@ -1244,7 +1245,7 @@ const SCRIPTING_ROWS = [
 const HELP_JSON_SCHEMA_VERSION = 1;
 const CLI_NAME_WORD_PATTERN = new RegExp(`(^|[^\\w-])${CLI_NAME}($|[^\\w-])`);
 
-var version = "0.0.5";
+var version = "0.0.6";
 
 const BUILD_BASE_URL = 'https://api.openemail.uk';
 
@@ -3495,7 +3496,7 @@ const DomainsCreateAddressMethod = {
     scopes: ['domains:write'],
     parameters: [
         { name: 'id', type: 'string', required: true, description: 'Domain id from `list` or `create`, a UUID.' },
-        { name: 'body.localPart', type: 'string', required: true, description: 'The part in front of the @, 1 to 64 characters once trimmed, lower cased. Letters, digits and ! # $ % & \' * + / = ? ^ _ ` { | } ~ - are allowed, and so are dots between them. `*` on its own is how the catch-all is written and is refused.' },
+        { name: 'body.localPart', type: 'string', required: true, description: 'The part in front of the @, 1 to 64 characters once trimmed, lower cased. Letters, digits, the backtick and ! # $ % & \' * + / = ? ^ _ { | } ~ - are allowed, and so are dots between them. `*` on its own is how the catch-all is written and is refused.' },
         { name: 'body.label', type: 'string | null', required: false, description: 'A name for the address shown in the app, trimmed, up to 120 characters. Leave it out, or send null or an empty string, for none.' },
         { name: 'options.signal', type: 'AbortSignal', required: false, description: 'Cancels the request.' },
         { name: 'options.apiKey', type: 'string', required: false, description: 'Overrides the client\'s API key for this call only.' }
@@ -13921,6 +13922,7 @@ const RESOURCE_ID_LIST_KEY = 'ids';
 const RESOURCE_ID_LIST_SUFFIX = 'Ids';
 const RESOURCE_MAX_SAMPLE = '100';
 const RESOURCE_READ_METHOD = 'GET';
+const RESOURCE_PATCH_METHOD = 'PATCH';
 const RESOURCE_EXAMPLE_LIMIT = 5;
 const RESOURCE_EXAMPLE_OPTIONAL_FLAGS = 3;
 const RESOURCE_CONFIRM_TARGET_LIMIT = 5;
@@ -13941,6 +13943,7 @@ const RESOURCE_UNSUPPORTED_ESCAPE = /\\[^'\\]/;
 const RESOURCE_SECRET_FLAG = /(key|token|secret|password)$/;
 const RESOURCE_SENTENCE_BREAK = /(?<=[.!?])\s+(?=[A-Z`])/;
 const RESOURCE_CAMEL_PATH = /^[a-z]+[A-Z][A-Za-z]*$/;
+const RESOURCE_EMPTY_STRING_CLEAR = /(\b[Nn]ull\b|`null`) or an empty string/g;
 const RESOURCE_EXAMPLE_PATTERNS = {
     STRING: /(\w+):\s*'((?:[^'\\\n]|\\.)*)'/g,
     NUMBER: /(\w+):\s*(-?\d+(?:\.\d+)?)(?=\s*[,}\n])/g,
@@ -13979,6 +13982,7 @@ const RESOURCE_HELP = {
     REQUIRED: 'Required.',
     REQUIRED_WITH_DATA: 'Required, here or in `--data`.',
     PAGING: 'Add `--all` to walk every page: a table on a terminal, one JSON object per line when piped or with `--ndjson`, and one `{ items, hasMore, nextCursor }` document with `--json`. `--max <n>` stops after that many items.',
+    PAGING_OWN_SHAPE: 'Add `--all` to walk every page: a table on a terminal, one JSON object per line when piped or with `--ndjson`, and one JSON document with `--json`, shaped as Returns describes. `--max <n>` stops after that many items.',
     DATA_USAGE: '--data <json|@file|->',
     JSON_TYPE: (type) => `JSON shaped as \`${type}\`, inline or from a file with @path.`
 };
@@ -14268,6 +14272,7 @@ const TERMINAL = {
     MIN_WRAP_WIDTH: 16
 };
 const CODE_SPAN_DELIMITER = '`';
+const CODE_SPAN_PATTERN = /`([^`\s](?:[^`]*[^`\s])?)`/g;
 const BANNER_LINES = [
     '                                           _  _',
     ' ___   _ __  ___  _ _   ___  _ __   __ _ (_)| |',
@@ -15535,13 +15540,7 @@ const Config$1 = {
     Update: Update$1
 };
 
-const FormatCode = (text, paint) => {
-    const parts = text.split(CODE_SPAN_DELIMITER);
-    if (parts.length < 3)
-        return text;
-    const balanced = parts.length % 2 === 1 ? parts : [...parts.slice(0, -2), `${parts[parts.length - 2]}${CODE_SPAN_DELIMITER}${parts[parts.length - 1]}`];
-    return balanced.map((part, index) => index % 2 === 1 ? paint(part) : part).join('');
-};
+const FormatCode = (text, paint) => text.replace(CODE_SPAN_PATTERN, (_span, code) => paint(code));
 
 const KNOWN_KINDS = new Set(Object.values(PROFILE_KINDS));
 const IsUsable = (value) => IsRecord$2(value) && KNOWN_KINDS.has(value.kind) && typeof value.baseUrl === 'string';
@@ -17622,6 +17621,17 @@ const NonEmptyEnv = (name) => {
     return value === undefined || value.length === 0 ? null : value;
 };
 
+const LOCAL_NETWORK = /^(localhost|127\.\d+\.\d+\.\d+|0\.0\.0\.0|\[::1\]|10\.\d+\.\d+\.\d+|192\.168\.\d+\.\d+|172\.(1[6-9]|2\d|3[01])\.\d+\.\d+|[^/:]+\.local)(:|\/|$)/i;
+
+const withScheme = (value) => {
+    const trimmed = value.trim();
+    if (trimmed === '' || /^https?:\/\//i.test(trimmed))
+        return trimmed;
+    const bare = trimmed.replace(/^\/+/, '');
+    return `${LOCAL_NETWORK.test(bare) ? 'http' : 'https'}://${bare}`;
+};
+const publicUrl = (value) => withScheme(value).replace(/\/+$/, '');
+
 const Invalid = (value) => new UsageError(MESSAGES.INVALID_BASE_URL(Color.Sanitize(value)), { code: CLI_ERROR_CODES.INVALID_VALUE });
 const Parse$3 = (url) => {
     try {
@@ -17641,8 +17651,8 @@ const Unspecified = (normalised, url) => new UsageError(MESSAGES.UNSPECIFIED_HOS
     next: MESSAGES.UNSPECIFIED_HOST_NEXT(Color.Sanitize(LoopbackInstead(url)))
 });
 const NormaliseUrl = (value) => {
-    const normalised = NormaliseEndpoint(value);
-    if (normalised === undefined)
+    const normalised = publicUrl(value);
+    if (normalised.length === 0)
         throw Invalid(value);
     const url = Parse$3(normalised);
     if (url === null || (url.protocol !== URL_PROTOCOLS.HTTP && url.protocol !== URL_PROTOCOLS.HTTPS))
@@ -19257,11 +19267,7 @@ const PathOf = (raw) => {
         return raw;
     }
 };
-const WithoutDocsPrefix = (path) => {
-    if (path === DOCS_PATHS.DOCS_PREFIX.slice(0, -1))
-        return '';
-    return path.startsWith(DOCS_PATHS.DOCS_PREFIX) ? path.slice(DOCS_PATHS.DOCS_PREFIX.length) : path;
-};
+const WithoutDocsPrefix = (path) => path.replace(DOCS_PATTERNS.DOCS_PREFIX, '');
 const Decoded = (segment) => {
     try {
         return decodeURIComponent(segment);
@@ -26578,7 +26584,7 @@ const RunVerb = (namespace, verb) => async (context) => {
 
 const Code = (text) => `${CODE_SPAN_DELIMITER}${text}${CODE_SPAN_DELIMITER}`;
 const VerbProse = (verb, text) => {
-    let prose = text;
+    let prose = text.replace(RESOURCE_EMPTY_STRING_CLEAR, '$1');
     for (const flag of verb.flags) {
         if (flag.parameter === null)
             continue;
@@ -26609,7 +26615,10 @@ const VerbArguments = (verb) => verb.positionals.map(positional => ({
 
 const VerbDescription = (verb) => {
     const prose = VerbProse(verb, verb.entry.description).trim();
-    return verb.paginates ? `${prose}\n\n${RESOURCE_HELP.PAGING}` : prose;
+    if (!verb.paginates)
+        return prose;
+    const paging = verb.returns.layout === MANIFEST_DEFAULT_PAGE_LAYOUT ? RESOURCE_HELP.PAGING : RESOURCE_HELP.PAGING_OWN_SHAPE;
+    return `${prose}\n\n${paging}`;
 };
 
 const Collect = (fields, example, pattern, value) => {
@@ -26706,9 +26715,10 @@ const VerbExamples = (namespace, verb, known) => {
     })
         .slice(0, RESOURCE_EXAMPLE_OPTIONAL_FLAGS)
         .flat();
-    const examples = [{ command: Join(essential) }];
+    const emptyPatch = verb.entry.method.toUpperCase() === RESOURCE_PATCH_METHOD && required.length === 0 && optional.length > 0;
+    const examples = emptyPatch ? [] : [{ command: Join(essential) }];
     if (optional.length > 0) {
-        if (required.length > 0 || verb.positionals.some(positional => positional.required))
+        if (!emptyPatch && (required.length > 0 || verb.positionals.some(positional => positional.required)))
             examples[0].note = RESOURCE_EXAMPLE_NOTES.REQUIRED;
         examples.push({ command: Join([...essential, ...optional]), note: RESOURCE_EXAMPLE_NOTES.FULL });
     }
@@ -26729,7 +26739,7 @@ const VerbExamples = (namespace, verb, known) => {
     }
     const reads = verb.entry.method.toUpperCase() === RESOURCE_READ_METHOD && verb.returns.shape === MANIFEST_RETURN_SHAPES.OBJECT;
     if (examples.length < 2 || reads) {
-        examples.push({ command: Join([...essential, `--${GLOBAL_FLAG_NAMES.JSON}`]), note: RESOURCE_EXAMPLE_NOTES.JSON });
+        examples.push({ command: Join([...essential, ...(emptyPatch ? optional : []), `--${GLOBAL_FLAG_NAMES.JSON}`]), note: RESOURCE_EXAMPLE_NOTES.JSON });
     }
     return examples.slice(0, RESOURCE_EXAMPLE_LIMIT);
 };

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@openemail/cli",
-    "version": "0.0.1",
+    "version": "0.0.2",
     "author": "OpenEmail",
     "license": "UNLICENSED",
     "description": "The official OpenEmail command line. Sign in once, then send and read mail, manage domains, addresses, keys, webhooks, templates, contacts, audiences and every other OpenEmail resource, use the AI tools and connect MCP clients from your terminal.",