@withgauge/cli 0.24.0 → 0.25.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +117 -6
- package/dist/batchWorker.js +1 -1
- package/dist/chatApi-W6HW3HKD.js +1 -0
- package/dist/chunk-E24F53BZ.js +1 -0
- package/dist/chunk-OIGVDK3F.js +2 -0
- package/dist/chunk-QV7MOO3M.js +2 -0
- package/dist/chunk-RRLAI72I.js +2 -0
- package/dist/chunk-UANK5LHE.js +69 -0
- package/dist/chunk-WJTCHKG6.js +1 -0
- package/dist/{chunk-KLWQOTEK.js → chunk-WYYRMPRX.js} +1 -1
- package/dist/index.js +63 -28
- package/dist/orgDirectory-BZW2ZAD3.js +1 -0
- package/dist/telemetryWorker.js +1 -1
- package/dist/worker.js +1 -1
- package/package.json +1 -1
- package/dist/chunk-FCK3MQPV.js +0 -2
- package/dist/chunk-NVAONV7U.js +0 -70
- package/dist/chunk-RB7Q72OV.js +0 -1
|
@@ -0,0 +1 @@
|
|
|
1
|
+
import{credentialKind,fetchDirectory,isUuid,keyOrganization,legacySelection,resolveSelection}from"./chunk-E24F53BZ.js";import{ApiClient,CliError,codeForStatus,resolveAuthUrl,resolveToken,retryAfterSeconds,storedSharedCredentials}from"./chunk-RRLAI72I.js";import{readConfig}from"./chunk-OIGVDK3F.js";import{existsSync,readFileSync}from"fs";import{dirname,join,resolve}from"path";function findWorkspace(cwd=process.cwd()){let directory=resolve(cwd);while(true){if(existsSync(join(directory,"gauge.json")))return directory;const parent=dirname(directory);if(parent===directory)return void 0;directory=parent}}function gaugeState(command,cwd=process.cwd()){return readGaugeState(command.optsWithGlobals(),cwd)}function backend(value,location){if(value===void 0)return void 0;if(value==="local"||value==="hosted")return value;throw new CliError("usage",`Invalid backend in ${location}: expected local or hosted`)}function readGaugeState(flags,cwd=process.cwd(),account={signedIn:resolveToken()!==null,...readConfig()}){const root=findWorkspace(cwd);let config;let workspaceBackend;if(root){try{const parsed=JSON.parse(readFileSync(join(root,"gauge.json"),"utf8"));config=parsed&&typeof parsed==="object"&&!Array.isArray(parsed)?parsed:null}catch{config=null}if(config&&"mode"in config)throw new CliError("usage","gauge.json does not accept mode. Set backend in private .gauge/config.json; keep the project manifest backend-independent.");const path=join(root,".gauge","config.json");if(existsSync(path)){let value;try{value=JSON.parse(readFileSync(path,"utf8"))}catch{throw new CliError("usage",`${path} is not valid JSON`)}if(!value||value.version!==1)throw new CliError("usage",`Unsupported workspace configuration version in ${path}`);workspaceBackend=backend(value.backend,path)}}const userBackend=backend(account.backend,"user configuration");const[mode,source]=flags.local?["local","flag"]:flags.hosted?["hosted","flag"]:workspaceBackend?[workspaceBackend,"workspace"]:userBackend?[userBackend,"user"]:["local","default"];return{mode,source,root,inRepo:root!==void 0,config,signedIn:account.signedIn,orgId:account.orgId}}function instructionMode(state){const why={flag:"from the flag",workspace:"from .gauge/config.json",user:"from user configuration",default:"the default"};return{mode:state.mode,why:why[state.source]}}function header(state,topic,brief=false){const{mode,why}=instructionMode(state);const lines=[`Mode: ${mode} (${why}). Pass --${mode==="local"?"hosted":"local"} to switch for this command.`];if(mode==="local"&&topic&&!topic.local&&!topic.shared)lines.push("This topic is hosted only. Local guidance: `gauge instructions --local`.");if(state.config===null)lines.push("gauge.json is not valid JSON. Fix it before using this workspace.");else if(!state.root&&!brief)lines.push("Run `gauge init` to initialize this directory. It writes gauge.json and private .gauge/ state. Add --cases only to scaffold shared gauge-cases/ files.");else if(!brief&&(!topic||topic.key==="root"))lines.push("Next: `gauge instructions eval` or `gauge instructions preference` to create a saved measurement; `gauge instructions run` to launch it.");return lines}function selectedOrg(command,fileOrg){const{org}=command.optsWithGlobals();if(org)return{value:org,source:"flag"};if(fileOrg)return{value:fileOrg,source:"file"};const project=gaugeState(command).config;if(typeof project?.orgId==="string"&&project.orgId){if(!isUuid(project.orgId))throw new CliError("usage","The organization saved in gauge.json is not valid.",{hint:"Run `gauge orgs`, then `gauge orgs use <slug> --project` to choose this project's organization."});return{value:project.orgId,source:"project"}}if(project?.org)legacySelection("project");const{orgId,defaultOrg}=readConfig();if(orgId){if(!isUuid(orgId))throw new CliError("usage","Your saved organization is not valid.",{hint:"Run `gauge orgs`, then `gauge orgs use <slug>` to choose your organization."});return{value:orgId,source:"config"}}if(defaultOrg)legacySelection("config");return void 0}var NO_ORG_MESSAGE="No organization selected. Pass --org <org> or set a default with `gauge orgs use <org>`.";async function resolveOrg(command,fileOrg){const selection=selectedOrg(command,fileOrg);if(!selection)throw new CliError("usage",NO_ORG_MESSAGE,{needsAccount:true});return(await resolveSelection(selection.value,selection.source)).id}function resolveOutput(command){const{output}=command.optsWithGlobals();return output==="json"?"json":"table"}function requireHosted(command,{account=false,hint}={}){const{mode,source}=gaugeState(command);if(mode==="local"&&(source==="flag"||!account))throw new CliError("usage","This command needs hosted Gauge.",{needsAccount:true,hint})}function hostedOnly(command,options={}){return command.hook("preAction",(_command,action)=>requireHosted(action,options))}var OUTPUT_FORMATS=["table","json"];function colorEnabled(stream){if(process.env.FORCE_COLOR)return process.env.FORCE_COLOR!=="0";return stream.isTTY===true&&!process.env.NO_COLOR&&process.env.TERM!=="dumb"}function style(code,stream=process.stdout){const on=colorEnabled(stream);return text=>on?`\x1B[${code}m${text}\x1B[0m`:text}function printJson(value){console.log(JSON.stringify(value,null,2))}function printItems(items,format,columns){if(format==="json"){printJson(items);return}if(items.length===0){console.log("(no results)");return}const cols=columns??Object.keys(items[0]).map(key=>({key}));const headers=cols.map(col=>col.header??col.key);const rows=items.map(item=>cols.map(col=>cell(item[col.key])));const widths=headers.map((header2,i)=>Math.max(header2.length,...rows.map(row=>row[i].length)));const line=values=>values.map((value,i)=>value.padEnd(widths[i])).join(" ").trimEnd();console.log(line(headers));for(const row of rows)console.log(line(row))}function cell(value){if(value===null||value===void 0||value==="")return"\u2014";if(value instanceof Date)return value.toISOString();if(typeof value==="object")return JSON.stringify(value);return String(value)}var CHAT_API_PREFIX="/api/v1";var CHAT_BATCH_SIZE=500;var INVALID_CODES=new Set(["invalid_request","invalid_query","invalid_id","invalid_cursor","range_too_large"]);function exitFamily(status,code){if(code==="limit_exceeded")return"insufficient_credits";if(status===400||status===422||INVALID_CODES.has(code))return"invalid_request";if(code==="rate_limited")return"rate_limited";return codeForStatus(status)}function isChatErrorBody(value){const error=value?.error;return typeof error==="object"&&error!==null&&typeof error.code==="string"&&typeof error.message==="string"}function loginHint(){return process.env.GAUGE_API_TOKEN?.trim()?"Replace GAUGE_API_TOKEN with a valid key, or unset it and run `gauge auth login`.":"Run `gauge auth login`, or set GAUGE_API_TOKEN to an org API key (Settings \u2192 API Keys)."}function hintFor(code,field,extra,retryAfter){switch(code){case"forbidden":return field==="explain"?"--explain (or `explain` in --json) is only available to Gauge staff; rerun without it.":void 0;case"unauthorized":return loginHint();case"insufficient_scope":return extra.requiredScope&&extra.requiredScope!=="write"?`Ask an organization admin for '${String(extra.requiredScope)}' permission.`:"Ask an organization admin for write access, or create a Read & write API key in Settings \u2192 API Keys.";case"limit_exceeded":return typeof extra.remaining==="number"?`Your plan allows ${extra.remaining} more prompt(s); nothing was created.`:"Nothing was created.";case"rate_limited":return retryAfter===void 0?"Retry shortly.":`Retry in ${retryAfter} s.`;case"product_not_enabled":return"Run `gauge orgs` to see which products each organization uses.";default:return void 0}}function describeScopes(scopes){if(scopes.includes("write"))return"read & write";if(scopes.length===1&&scopes[0]==="read")return"read-only";return scopes.length?scopes.join(", "):"no permissions"}var ChatApiClient=class extends ApiClient{describingScope=false;orgName;async me(){try{return await this.get(chatPath("me"))}catch(error){if(!(error instanceof CliError)||error.code!=="not_found")throw error;throw new CliError("not_found","This Gauge server cannot show your account details yet.",{hint:"Run `gauge orgs` to check your access. If you use a custom Gauge server, ask its administrator to update it."})}}async scopeHint(required){if(this.describingScope)return void 0;this.describingScope=true;try{const{token}=await this.me();const needs=String(required??"write");const access=token.scopes.length?`${describeScopes(token.scopes)} access`:"no permissions";if(token.kind==="api_key")return`This API key has ${access}.${needs==="write"?" Create a Read & write key in Settings \u2192 API Keys, then update GAUGE_API_TOKEN or import it with `gauge auth login --with-token`.":` Use a key with '${needs}' permission.`}`;if(token.kind==="session")return`Your login has ${access}. Ask an organization admin for ${needs==="write"?"write access":`'${needs}' permission`}.`;return void 0}catch{return void 0}finally{this.describingScope=false}}constructor(options={}){super({...options,baseUrl:options.baseUrl??storedSharedCredentials()?.authUrl??resolveAuthUrl()})}headers(extra){if(!this.signedIn)throw new CliError("unauthorized","Not logged in to Gauge.",{hint:loginHint()});return super.headers(extra)}async toError(res){let body;try{body=await res.clone().json()}catch{}if(!isChatErrorBody(body)){if(res.status===404)return unknownEndpoint(res);return super.toError(res)}const{code,message,field,...extra}=body.error;const retryAfter=typeof extra.retryAfter==="number"?extra.retryAfter:res.status===429?retryAfterSeconds(res):void 0;const details={status:res.status,...field?{field}:{},...extra,...retryAfter!==void 0?{retryAfter}:{}};if(code==="product_not_enabled"&&this.orgName)return new CliError(exitFamily(res.status,code),`${this.orgName} doesn't use Gauge Chat.`,{apiCode:code,details,hint:hintFor(code,field,extra,retryAfter)});return new CliError(exitFamily(res.status,code),`${code==="insufficient_scope"?"You don't have the permissions needed for this command.":message}${field?` (field: ${field})`:""}`,{apiCode:code,details,hint:(code==="insufficient_scope"?await this.scopeHint(extra.requiredScope):void 0)??hintFor(code,field,extra,retryAfter)})}};function unknownEndpoint(res){const url=res.url?new URL(res.url):void 0;return new CliError("not_found",`This Gauge server${url?` (${url.host})`:""} does not support this command at the requested address.`,{details:{status:404,...url?{path:url.pathname}:{}},hint:"Check GAUGE_AUTH_URL or `gauge config get authUrl` if you use a custom server. Otherwise, contact Gauge support."})}function createChatApiClient(options={}){return new ChatApiClient(options)}function chatPath(...segments){return`${CHAT_API_PREFIX}/${segments.map(encodeURIComponent).join("/")}`}async function resolveChatOrg(command){const{org}=command.optsWithGlobals();const isKey=credentialKind()==="api_key";const selection=isKey?org?{value:org,source:"flag"}:void 0:selectedOrg(command);if(selection){const resolved=await resolveSelection(selection.value,selection.source);return{id:resolved.id,name:resolved.name,source:selection.source}}if(isKey){const keyOrg=await keyOrganization();return{id:keyOrg.id,name:keyOrg.name,source:"key"}}const chatOrgs=(await fetchDirectory()).filter(o=>o.products?.chat!==false);if(chatOrgs.length===1)return{id:chatOrgs[0].id,name:chatOrgs[0].name,source:"only"};throw new CliError("usage",chatOrgs.length===0?"You are not a member of any organization with Gauge Chat.":`Several organizations have Gauge Chat (${chatOrgs.map(o=>o.slug).join(", ")}). Pass --org <org> or run \`gauge orgs use <org>\`.`)}async function resolveChatCategory(command,client,org){const{category}=command.optsWithGlobals();if(category)return category;const{chatCategory,chatCategoryOrg}=readConfig();if(chatCategory&&(chatCategoryOrg?chatCategoryOrg===org.id:org.source==="config"))return chatCategory;const{data}=await client.get(chatPath("orgs",org.id,"categories"));if(data.length===1)return data[0].slug;const label=org.name??org.id;throw new CliError("usage",data.length===0?`Organization ${label} has no categories.`:`Organization ${label} has several categories (${data.map(c=>c.slug).join(", ")}). Pass --category <slug> or run \`gauge chat categories use <slug>\`.`)}async function chatScope(command){const client=createChatApiClient();const chatOrg=await resolveChatOrg(command);client.orgName=chatOrg.name??chatOrg.id;return{client,org:chatOrg.id,chatOrg}}async function categoryScope(command){const scope=await chatScope(command);const category=await resolveChatCategory(command,scope.client,scope.chatOrg);return{...scope,category,base:["orgs",scope.org,"categories",category]}}var DEFAULT_MAX_ITEMS=5e3;function parsePositive(raw,flag,max){if(raw===void 0)return void 0;const value=Number(raw);if(!Number.isInteger(value)||value<1||max&&value>max)throw new CliError("usage",`${flag} must be an integer${max?` between 1 and ${max}`:" of at least 1"}`);return value}async function fetchPages(client,path,query,options,maxLimit=200){const limit=parsePositive(options.limit,"--limit",maxLimit);if(!options.all)return client.get(path,{...query,limit,cursor:options.cursor});const max=parsePositive(options.max,"--max")??DEFAULT_MAX_ITEMS;const data=[];let cursor=options.cursor;do{const page=await client.get(path,{...query,limit:Math.min(limit??maxLimit,max-data.length),cursor});data.push(...page.data);cursor=page.nextCursor??void 0}while(cursor&&data.length<max);return{data,nextCursor:cursor??null}}async function fetchAll(client,path,query={}){return(await fetchPages(client,path,query,{all:true})).data}function printPage(page,output,row){if(output==="json"){printJson({data:page.data,nextCursor:page.nextCursor??null});return}printItems(page.data.map(row),"table");if(page.nextCursor)console.error(`(more results \u2014 rerun with --cursor ${page.nextCursor}, or pass --all)`)}function addPageOptions(command,maxLimit=200){return command.option("--limit <n>",`page size (1-${maxLimit})`).option("--cursor <cursor>","resume from a previous page's nextCursor").option("--all","follow nextCursor through every page").option("--max <n>",`with --all, stop after this many items (default ${DEFAULT_MAX_ITEMS})`)}function chunks(items,size=CHAT_BATCH_SIZE){const out=[];for(let i=0;i<items.length;i+=size)out.push(items.slice(i,i+size));return out}var csv=raw=>raw.split(",").map(s=>s.trim()).filter(Boolean);function truncate(text,length=80){const flat=text.replace(/\s+/g," ").trim();return flat.length>length?`${flat.slice(0,length-1)}\u2026`:flat}var lower=s=>s.trim().toLowerCase();async function resolveTopicId(scope,value){if(value.startsWith("top_"))return value;const topics=await fetchAll(scope.client,chatPath(...scope.base,"topics"));const match=topics.filter(t=>t.slug===value||lower(t.title)===lower(value));if(match.length===1)return match[0].id;throw new CliError("not_found",match.length?`Topic "${value}" is ambiguous; pass its id (${match.map(t=>t.id).join(", ")}).`:`Topic "${value}" not found in category ${scope.category}.`,{hint:"Run `gauge chat topics list`, or create it with `gauge chat topics create`."})}async function resolveTagIds(scope,values){if(values.every(v=>v.startsWith("tag_")))return values;const tags=await fetchAll(scope.client,chatPath("orgs",scope.org,"tags"));return values.map(value=>{if(value.startsWith("tag_"))return value;const match=tags.filter(t=>lower(t.name)===lower(value));if(match.length===1)return match[0].id;throw new CliError("not_found",match.length?`Tag "${value}" is ambiguous; pass its id (${match.map(t=>t.id).join(", ")}).`:`Tag "${value}" not found.`,{hint:"Run `gauge chat tags list`, or create it with `gauge chat tags create`."})})}function withCategory(command){return command.option("--category <category>","category slug or cat_ id (default: chatCategory config, else the org's only category)")}export{findWorkspace,gaugeState,readGaugeState,instructionMode,header,resolveOrg,resolveOutput,requireHosted,hostedOnly,OUTPUT_FORMATS,style,printJson,printItems,CHAT_API_PREFIX,CHAT_BATCH_SIZE,describeScopes,ChatApiClient,createChatApiClient,chatPath,resolveChatOrg,resolveChatCategory,chatScope,categoryScope,DEFAULT_MAX_ITEMS,parsePositive,fetchPages,fetchAll,printPage,addPageOptions,chunks,csv,truncate,resolveTopicId,resolveTagIds,withCategory};
|
|
@@ -1,3 +1,3 @@
|
|
|
1
|
-
import{configDir}from"./chunk-
|
|
1
|
+
import{configDir}from"./chunk-OIGVDK3F.js";import{randomUUID}from"crypto";import{link,mkdir,readFile,rename,rm,writeFile}from"fs/promises";import{join}from"path";function hasCode(error,code){return typeof error==="object"&&error!==null&&"code"in error&&error.code===code}async function telemetryStatus(directory=configDir()){if(process.env.GAUGE_TELEMETRY_DISABLED==="1")return{enabled:false,source:"environment"};try{const value=JSON.parse(await readFile(join(directory,"telemetry.json"),"utf8"));if(typeof value!=="object"||value===null||!("enabled"in value)||typeof value.enabled!=="boolean")return{enabled:false,source:"unavailable"};return{enabled:value.enabled,source:"preference"}}catch(error){return hasCode(error,"ENOENT")?{enabled:true,source:"default"}:{enabled:false,source:"unavailable"}}}async function setTelemetryEnabled(enabled,directory=configDir()){await mkdir(directory,{recursive:true,mode:448});const temporary=join(directory,`.telemetry-${randomUUID()}.tmp`);try{await writeFile(temporary,`${JSON.stringify({enabled})}
|
|
2
2
|
`,{mode:384,flag:"wx"});await rename(temporary,join(directory,"telemetry.json"))}finally{await rm(temporary,{force:true})}}async function installationId(directory=configDir()){const path=join(directory,"telemetry-id");try{return validId(await readFile(path,"utf8"))}catch(error){if(!hasCode(error,"ENOENT"))throw error}await mkdir(directory,{recursive:true,mode:448});const id=randomUUID();const temporary=join(directory,`.telemetry-id-${id}.tmp`);try{await writeFile(temporary,`${id}
|
|
3
3
|
`,{mode:384,flag:"wx"});try{await link(temporary,path)}catch(error){if(!hasCode(error,"EEXIST"))throw error}return validId(await readFile(path,"utf8"))}finally{await rm(temporary,{force:true})}}function validId(raw){const id=raw.trim();if(!/^[0-9a-f]{8}-[0-9a-f]{4}-4[0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$/i.test(id))throw new Error("Invalid telemetry identity");return id}export{telemetryStatus,setTelemetryEnabled,installationId};
|