@localauth/cli 0.4.0 → 0.4.2

package/cli/ask.ts

@@ -1,7 +1,7 @@
 import { spawn } from 'node:child_process'
 import * as fs from 'node:fs/promises'
 import * as path from 'node:path'
-import { answerFields, isAskRequest, isFieldName, isReservedName } from '../shared/ask.ts'
+import { answerFields, isApproval, isAskRequest, isFieldName, isReservedName, MAX_APPROVAL_DESCRIPTION } from '../shared/ask.ts'
 import { setTimeout as sleep } from 'node:timers/promises'
 import type { AnswerData, AskRequest, RunData } from '../shared/protocol.ts'
 import { isAnswer } from '../shared/validation.ts'
@@ -184,7 +184,7 @@ export async function approve(connection: Connection, options: ApproveOptions, s
   let expiresAt = Date.now() + Math.ceil(options.timeout * 60_000)
   let request: AskRequest = { title: options.title, description: options.description, fields: [{ name: 'APPROVE', label: 'Approve', secret: false, required: true }] }
   let data: RunData = { authenticatedMessages: true, kind: 'ask', approval: true, title: options.title, ask: request, expiresAt, command: '', flows: [], output: '', exitCode: null, attempt: 1, retryUntil: null }
-  if (!isAskRequest(data.ask)) throw new Error('Invalid approval request.')
+  if (!isAskRequest(data.ask, MAX_APPROVAL_DESCRIPTION)) throw new Error('Invalid approval request.')
   let run = await createRun(connection, [], say, { retry: false, link: false }, data)
   let stop = new AbortController(), interrupted = 0
   let listeners = Object.entries({ SIGINT: 130, SIGTERM: 143, SIGHUP: 129 }).map(([signal, code]) => {
@@ -201,7 +201,7 @@ export async function approve(connection: Connection, options: ApproveOptions, s
           if (message.kind === 'decline') { decided = false; break }
           if (message.kind !== 'answer' || typeof message.data !== 'string' || !message.data.startsWith('a1.')) continue
           let value = await run.openMessage<AnswerData>('answer', message.data)
-          if (isAnswer(value) && !value.declined && answerFields(value, request)?.APPROVE === 'yes') { decided = true; break }
+          if (isApproval(value)) { decided = true; break }
         }
         if (decided === null) await sleep(Math.min(1500, Math.max(1, expiresAt - Date.now())), undefined, { signal })
       } catch (error) { if (!signal.aborted) throw error }

package/cli/cli.ts

@@ -35,6 +35,7 @@ Usage:
   localauth approve --title <text> [--description <text>] [--timeout <minutes>]
                                       Wait for the owner to allow something. They answer from their
                                       signed-in list with a fresh passkey check; no link is made
+                                      Description: max 8000
                                       Needs end-to-end encryption; exits 0 if approved, 1 otherwise
   localauth finish [<callback-url>]   Hand a pasted http://localhost:... address to the waiting command
                                       (reads it from stdin when omitted, keeping it out of ps)

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@localauth/cli",
-  "version": "0.4.0",
+  "version": "0.4.2",
   "description": "Finish CLI logins on a headless server from your phone, with optional passkey-based end-to-end encryption",
   "license": "MIT",
   "type": "module",

package/shared/ask.ts

@@ -10,10 +10,12 @@ export function isFieldName(name: unknown): name is string {
 function object(value: unknown): value is Record<string, unknown> {
   return value !== null && typeof value === 'object' && !Array.isArray(value)
 }
-export function isAskRequest(value: unknown): value is AskRequest {
+/** An approval may have to show everything being approved, such as a whole diff. */
+export const MAX_APPROVAL_DESCRIPTION = 8000
+export function isAskRequest(value: unknown, maxDescription = 2000): value is AskRequest {
   if (!object(value)
     || (value.title !== undefined && (typeof value.title !== 'string' || !value.title.length || value.title.length > 120))
-    || (value.description !== undefined && (typeof value.description !== 'string' || value.description.length > 2000))
+    || (value.description !== undefined && (typeof value.description !== 'string' || value.description.length > maxDescription))
     || !Array.isArray(value.fields) || value.fields.length < 1 || value.fields.length > 10) return false
   let names = new Set<string>()
   return value.fields.every(field => {
@@ -44,6 +46,11 @@ export function answerFields(answer: unknown, request: AskRequest, legacy = fals
   return Object.fromEntries(request.fields.filter(field => Object.hasOwn(fields, field.name)).map(field => [field.name, fields[field.name]]))
 }
 
+/** Whether an answer approves. Only the answer matters here: an approval's description can be longer than an ask's. */
+export function isApproval(answer: unknown): boolean {
+  return answerFields(answer, { fields: [{ name: 'APPROVE', label: 'Approve', secret: false, required: true }] })?.APPROVE === 'yes'
+}
+
 /** Plain text segments and HTTP(S) URLs only. JSX renders both labels and segments as escaped text. */
 export function descriptionParts(text: string): { text: string; href?: string }[] {
   return text.split(/(https?:\/\/[^\s<>"']+)/g).filter(Boolean).map(text => {

package/shared/validation.ts

@@ -1,5 +1,5 @@
 import type { InputData, CallbackData, RunData } from './protocol.ts'
-import { isAskRequest } from './ask.ts'
+import { isAskRequest, MAX_APPROVAL_DESCRIPTION } from './ask.ts'
 export { isAnswer } from './ask.ts'
 export function isCallback(value: unknown): value is CallbackData {
   let v = value as CallbackData | null
@@ -13,7 +13,7 @@ export function isRunData(value: unknown): value is RunData {
     && (v.approval === undefined || (v.approval === true && v.kind === 'ask'))
     && (v.inputEnabled === undefined || typeof v.inputEnabled === 'boolean')
     && (v.secret === undefined || typeof v.secret === 'boolean')
-    && (v.ask === undefined || (v.kind === 'ask' && isAskRequest(v.ask)))
+    && (v.ask === undefined || (v.kind === 'ask' && isAskRequest(v.ask, v.approval ? MAX_APPROVAL_DESCRIPTION : undefined)))
     && (v.answerNote === undefined || (typeof v.answerNote === 'string' && v.answerNote.length <= 240))
     && (v.expiresAt === undefined || (Number.isSafeInteger(v.expiresAt) && v.expiresAt >= 0))
     && (v.machineName === undefined || (typeof v.machineName === 'string' && v.machineName.length <= 253))