hymnkeep 0.1.1 → 0.1.3

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 CHANGED
@@ -30,19 +30,50 @@ hymnkeep put "Gathering Hymn" "O Come, All Ye Faithful" --day 2026-12-27
30
30
  hymnkeep put Psalm "Psalm 98" --at "Sun 8:00 AM" --preview
31
31
  hymnkeep add-slot "Communion Meditation" --at "Sun 8:00 AM"
32
32
  hymnkeep remove-slot Postlude --at Vigil
33
+ hymnkeep remove-slot Communion --at "Sun 8:00 AM" --holding "Ave Maria"
33
34
 
34
35
  hymnkeep assign "Karis Wolfe" --job Cantor --day 2026-12-27
35
36
  hymnkeep assign "Adult Choir" --at "Sun 11:00 AM"
36
37
  hymnkeep unassign "Karis Wolfe" --at Vigil
37
- hymnkeep copy --from "Sat 5:30 PM" --to "Sun 8:00 AM"
38
+ hymnkeep copy --from "Sat 5:30 PM" --to "Sun 8:00 AM" --replace
39
+
40
+ hymnkeep upload "Shepherd Me (SATB).pdf" --to "Shepherd Me, O God" --part SATB
41
+ hymnkeep upload melody.mp3 --to "Gather Us In" --for tune --part Melody
42
+ ```
43
+
44
+ A command acts on every service of the day unless `--at` names some. Every
45
+ command that changes something takes `--preview`, which says what it would do
46
+ and writes nothing. `--json` prints what Hymnkeep sent, for scripts.
47
+
48
+ `remove-slot` takes one place from each service. Where a service has the slot
49
+ more than once, it takes the empty one, or the one holding the piece
50
+ `--holding` names. `copy` onto a service that already has music needs
51
+ `--replace` (take the first service's music instead) or `--add` (put it after).
52
+
53
+ `upload` takes PDF and MP3 files up to 64 MB, onto a piece in your library.
54
+ `--for` puts the file on something the piece reads from instead of the piece
55
+ itself: its tune, its text, or one book's printing, by name.
56
+
57
+ ## Any call
58
+
59
+ Everything else Hymnkeep can do is one call away. `hymnkeep api` lists the
60
+ calls, and `hymnkeep api <name> …` makes one:
61
+
62
+ ```sh
63
+ hymnkeep api occasions.index from=2026-11-01 to=2026-11-30
64
+ hymnkeep api music.library archived:=true q=gather
65
+ hymnkeep api services.slots.update occasion=<id> service=<id> slot=<id> piece_id=<id> 'spread[<service id>]=replace'
66
+ hymnkeep api music.files.store piece=<id> file=@score.pdf belongs_to=tune --preview
38
67
  ```
39
68
 
40
- A command acts on every service of the day unless `--at` names some.
41
- `--preview` says what it would do and writes nothing. `--json` prints what
42
- Hymnkeep sent, for scripts.
69
+ - `name=text` for text, and `name:=<json>` for a number, `true`, `null` or a list.
70
+ - `a[b]=value` for a nested field, and `a[]=value` to add to a list.
71
+ - `file=@path` for a file to upload; the call then goes as a form.
72
+ - `--data '<json>'` gives the whole body at once; pairs are added to it.
73
+ - `--preview` shows what would be sent, and sends nothing.
43
74
 
44
- Everything else Hymnkeep can do is one call away: `hymnkeep api` lists the
45
- calls, and `hymnkeep api <name> key=value …` makes one.
75
+ Ids go in the address, and the other fields where the call takes them. A field
76
+ the call does not list is still sent, with a note saying so.
46
77
 
47
78
  ## In an AI app
48
79
 
package/dist/cli.js CHANGED
@@ -5,7 +5,8 @@ import { stdin, stdout } from 'node:process';
5
5
  import { HymnkeepError, Hymnkeep } from './client.js';
6
6
  import { communityFrom, forget, load, save } from './config.js';
7
7
  import { serve } from './mcp.js';
8
- import { call, operation, operations } from './operations.js';
8
+ import { describe, operation, operations, request, send } from './operations.js';
9
+ import { parsePairs } from './params.js';
9
10
  import * as tasks from './tasks.js';
10
11
  const program = new Command();
11
12
  program
@@ -114,8 +115,13 @@ where(program
114
115
  .description('Put a piece in a place at every service named, replacing what the place held.')
115
116
  .option('--both', 'where the place holds something else, sing both instead of replacing')
116
117
  .option('--preview', 'say what it would do, and write nothing')).action((slot, piece, o) => run(() => tasks.put(api(), { when: o.day, slot, piece: piece.join(' '), services: o.at, both: o.both, preview: o.preview })));
117
- where(program.command('add-slot').argument('<slot>', 'a slot name').description('Add a slot, empty, to every service named.')).action((slot, o) => run(() => tasks.addSlot(api(), { when: o.day, slot, services: o.at })));
118
- where(program.command('remove-slot').argument('<slot>', 'a slot name').description('Take a slot off every service named.')).action((slot, o) => run(() => tasks.removeSlot(api(), { when: o.day, slot, services: o.at })));
118
+ where(program.command('add-slot').argument('<slot>', 'a slot name').description('Add a slot, empty, to every service named.').option('--preview', 'say what it would do, and write nothing')).action((slot, o) => run(() => tasks.addSlot(api(), { when: o.day, slot, services: o.at, preview: o.preview })));
119
+ where(program
120
+ .command('remove-slot')
121
+ .argument('<slot>', 'a slot name')
122
+ .description('Take a slot, and whatever is in it, off every service named: one place a service.')
123
+ .option('--holding <piece>', 'where a service has the slot more than once, the one holding this piece')
124
+ .option('--preview', 'say what it would do, and write nothing')).action((slot, o) => run(() => tasks.removeSlot(api(), { when: o.day, slot, services: o.at, holding: o.holding, preview: o.preview })));
119
125
  where(program
120
126
  .command('assign')
121
127
  .argument('<who...>', 'a person or an ensemble, by name')
@@ -127,21 +133,39 @@ where(program
127
133
  .command('unassign')
128
134
  .argument('<who...>', 'a person or an ensemble, by name')
129
135
  .description('Take a person or an ensemble off every service named.')
130
- .option('--job <job>', 'only where they do this job')).action((who, o) => run(() => tasks.unassign(api(), { when: o.day, who: who.join(' '), job: o.job, services: o.at })));
136
+ .option('--job <job>', 'only where they do this job')
137
+ .option('--preview', 'say what it would do, and write nothing')).action((who, o) => run(() => tasks.unassign(api(), { when: o.day, who: who.join(' '), job: o.job, services: o.at, preview: o.preview })));
131
138
  program
132
139
  .command('copy')
133
140
  .description("Copy one service's music onto another of the same day.")
134
141
  .requiredOption('--from <service>')
135
142
  .requiredOption('--to <service>')
136
143
  .option('--day <day>', 'a date or an occasion id; the next occasion if left out')
137
- .option('--replace', "replace the second service's music rather than adding after it")
138
- .action((o) => run(() => tasks.copy(api(), { when: o.day, from: o.from, to: o.to, replace: o.replace })));
144
+ .option('--replace', "replace the second service's music with the first's")
145
+ .option('--add', "put the first service's music after what the second has")
146
+ .option('--preview', 'say what it would do, and write nothing')
147
+ .action((o) => run(() => tasks.copy(api(), { when: o.day, from: o.from, to: o.to, replace: o.replace, add: o.add, preview: o.preview })));
148
+ program
149
+ .command('upload')
150
+ .argument('<files...>', 'PDF or MP3 files, up to 64 MB each')
151
+ .requiredOption('--to <piece>', 'the piece in the library, by title or id')
152
+ .option('--for <place>', "where on the piece the file belongs: the tune, the text, or one book's printing (by its name); the piece itself if left out")
153
+ .option('--part <part>', 'a part the file holds ("Melody", "SATB"); repeat for more', collect)
154
+ .option('--preview', 'say what it would do, and send nothing')
155
+ .description('Upload scores and recordings to a piece in the library.')
156
+ .action((files, o) => run(() => tasks.upload(api(), { files, piece: o.to, place: o.for, parts: o.part, preview: o.preview })));
139
157
  program
140
158
  .command('api')
141
159
  .argument('[call]', 'a call by name; every call is listed if left out')
142
- .argument('[params...]', 'name=value for each of its ids and fields')
160
+ .argument('[params...]', 'its ids and fields: name=text, name:=<json> for a number, true, null or a list, a[b]=value for a nested field, a[]=value to add to a list, file=@path for a file to upload')
143
161
  .description('Any call the API offers, by name: the command-line door to everything.')
144
- .option('--data <json>', 'the whole body of a write, as JSON')
162
+ .option('--data <json>', 'the whole body of a write, as JSON; name=value pairs are added to it')
163
+ .option('--preview', 'show what would be sent, and send nothing')
164
+ .addHelpText('after', `
165
+ Examples:
166
+ hymnkeep api occasions.index from=2026-11-01 to=2026-11-30
167
+ hymnkeep api music.library archived:=true q=gather
168
+ hymnkeep api music.files.store piece=<id> file=@score.pdf belongs_to=tune --preview`)
145
169
  .action(async (name, params, o) => {
146
170
  if (!name) {
147
171
  for (const op of operations()) {
@@ -150,12 +174,19 @@ program
150
174
  return;
151
175
  }
152
176
  const op = operation(name);
153
- const values = o.data ? JSON.parse(o.data) : {};
154
- for (const pair of params) {
155
- const at = pair.indexOf('=');
156
- values[pair.slice(0, at)] = pair.slice(at + 1);
177
+ const values = parsePairs(params, o.data ? JSON.parse(o.data) : {});
178
+ const known = new Set([...op.pathParams, ...op.queryParams.map((p) => p.name), ...Object.keys((op.body?.properties ?? {}))]);
179
+ const unknown = Object.keys(values).filter((field) => !known.has(field));
180
+ if (unknown.length) {
181
+ process.stderr.write(`Note: ${op.id} does not list ${unknown.join(', ')}; sending ${unknown.length === 1 ? 'it' : 'them'} anyway.\n`);
182
+ }
183
+ const laid = request(op, values);
184
+ if (o.preview) {
185
+ stdout.write(`${describe(laid, load()?.url ? api().base : '')}\n`);
186
+ return;
157
187
  }
158
- stdout.write(`${JSON.stringify(await call(api(), op, values), null, 2)}\n`);
188
+ const answer = await send(api(), laid);
189
+ stdout.write(answer === null ? 'Done.\n' : `${JSON.stringify(answer, null, 2)}\n`);
159
190
  });
160
191
  program
161
192
  .command('mcp')
package/dist/client.js CHANGED
@@ -23,9 +23,20 @@ export class Hymnkeep {
23
23
  return this.credentials.community;
24
24
  }
25
25
  /** `path` is under `/api/p/{community}`, as `occasions` or `occasions/{id}`. */
26
+ /** Where calls go, for a preview to show. */
27
+ get base() {
28
+ return `${this.credentials.url}/api/p/${encodeURIComponent(this.credentials.community)}/`;
29
+ }
30
+ /**
31
+ * `query` is either pairs already named as Laravel reads them, or a plain
32
+ * object; `form` is a form with files in it, sent instead of a JSON body.
33
+ */
26
34
  async request(method, path, options = {}) {
27
- const url = new URL(`${this.credentials.url}/api/p/${encodeURIComponent(this.credentials.community)}/${path.replace(/^\/+/, '')}`);
28
- for (const [name, value] of Object.entries(options.query ?? {})) {
35
+ const url = new URL(`${this.base}${path.replace(/^\/+/, '')}`);
36
+ if (Array.isArray(options.query)) {
37
+ options.query.forEach(([name, value]) => url.searchParams.append(name, value));
38
+ }
39
+ for (const [name, value] of Array.isArray(options.query) ? [] : Object.entries(options.query ?? {})) {
29
40
  if (value === undefined || value === null) {
30
41
  continue;
31
42
  }
@@ -33,7 +44,7 @@ export class Hymnkeep {
33
44
  value.forEach((each) => url.searchParams.append(`${name}[]`, String(each)));
34
45
  }
35
46
  else {
36
- url.searchParams.set(name, String(value));
47
+ url.searchParams.set(name, typeof value === 'boolean' ? (value ? '1' : '0') : String(value));
37
48
  }
38
49
  }
39
50
  const response = await fetch(url, {
@@ -41,10 +52,10 @@ export class Hymnkeep {
41
52
  headers: {
42
53
  Authorization: `Bearer ${this.credentials.key}`,
43
54
  Accept: 'application/json',
44
- ...(options.body === undefined ? {} : { 'Content-Type': 'application/json' }),
55
+ ...(options.body === undefined || options.form ? {} : { 'Content-Type': 'application/json' }),
45
56
  'User-Agent': 'hymnkeep-cli',
46
57
  },
47
- body: options.body === undefined ? undefined : JSON.stringify(options.body),
58
+ body: options.form ?? (options.body === undefined ? undefined : JSON.stringify(options.body)),
48
59
  });
49
60
  const text = await response.text();
50
61
  const json = text === '' ? null : safeJson(text);
package/dist/mcp.js CHANGED
@@ -2,7 +2,8 @@ import { McpServer } from '@modelcontextprotocol/sdk/server/mcp.js';
2
2
  import { StdioServerTransport } from '@modelcontextprotocol/sdk/server/stdio.js';
3
3
  import { z } from 'zod';
4
4
  import { HymnkeepError } from './client.js';
5
- import { call, operation, operations } from './operations.js';
5
+ import { describe, operation, operations, request, send } from './operations.js';
6
+ import { Upload } from './params.js';
6
7
  import * as tasks from './tasks.js';
7
8
  const day = z.string().optional().describe('A date (YYYY-MM-DD) or an occasion id. The next occasion if left out.');
8
9
  const at = z.array(z.string()).optional().describe('Services by their time or name ("Sun 8:00 AM", "Vigil"). Every service of the day if left out.');
@@ -27,7 +28,7 @@ async function reply(task) {
27
28
  }
28
29
  }
29
30
  export function build(api) {
30
- const server = new McpServer({ name: 'hymnkeep', version: '0.1.0' }, { instructions: INSTRUCTIONS });
31
+ const server = new McpServer({ name: 'hymnkeep', version: '0.1.3' }, { instructions: INSTRUCTIONS });
31
32
  server.registerTool('whoami', { description: 'Who this key is: the community, the person, their role, and whether it may write.', annotations: READ }, () => reply(() => tasks.whoami(api)));
32
33
  server.registerTool('week', { description: "An occasion's services, its music place by place (where services differ, each one's), and who is on each service.", inputSchema: { day }, annotations: READ }, ({ day: when }) => reply(() => tasks.show(api, when)));
33
34
  server.registerTool('occasions', {
@@ -64,10 +65,14 @@ export function build(api) {
64
65
  }, ({ day: when, slot, piece, services, both, preview: look }) => reply(() => tasks.put(api, { when, slot, piece, services, both, preview: look })));
65
66
  server.registerTool('add_slot', {
66
67
  description: 'Add a slot, empty, to the services named, at the end of each one\'s list.',
67
- inputSchema: { day, slot: z.string().describe("A slot name from the community's list."), services: at },
68
+ inputSchema: { day, slot: z.string().describe("A slot name from the community's list."), services: at, preview },
68
69
  annotations: WRITE,
69
- }, ({ day: when, slot, services }) => reply(() => tasks.addSlot(api, { when, slot, services })));
70
- server.registerTool('remove_slot', { description: 'Take a slot, and whatever is in it, off the services named.', inputSchema: { day, slot: z.string(), services: at }, annotations: REMOVE }, ({ day: when, slot, services }) => reply(() => tasks.removeSlot(api, { when, slot, services })));
70
+ }, ({ day: when, slot, services, preview: look }) => reply(() => tasks.addSlot(api, { when, slot, services, preview: look })));
71
+ server.registerTool('remove_slot', {
72
+ description: 'Take a slot, and whatever is in it, off the services named: one place a service. Where a service has the slot twice, the empty one goes, or the one holding the piece named.',
73
+ inputSchema: { day, slot: z.string(), services: at, holding: z.string().optional().describe('The piece in the place to take, where a service has the slot more than once.'), preview },
74
+ annotations: REMOVE,
75
+ }, ({ day: when, slot, services, holding, preview: look }) => reply(() => tasks.removeSlot(api, { when, slot, services, holding, preview: look })));
71
76
  server.registerTool('assign_musician', {
72
77
  description: 'Assign a person to a job, or an ensemble, at the services named. Where someone else does that job, they are replaced unless both is true.',
73
78
  inputSchema: {
@@ -80,12 +85,19 @@ export function build(api) {
80
85
  },
81
86
  annotations: WRITE,
82
87
  }, ({ day: when, who, job, services, both, preview: look }) => reply(() => tasks.assign(api, { when, who, job, services, both, preview: look })));
83
- server.registerTool('unassign_musician', { description: 'Take a person or an ensemble off the services named.', inputSchema: { day, who: z.string(), job: z.string().optional(), services: at }, annotations: REMOVE }, ({ day: when, who, job, services }) => reply(() => tasks.unassign(api, { when, who, job, services })));
88
+ server.registerTool('unassign_musician', { description: 'Take a person or an ensemble off the services named.', inputSchema: { day, who: z.string(), job: z.string().optional(), services: at, preview }, annotations: REMOVE }, ({ day: when, who, job, services, preview: look }) => reply(() => tasks.unassign(api, { when, who, job, services, preview: look })));
84
89
  server.registerTool('copy_music', {
85
90
  description: "Copy one service's music onto another of the same day, after what it has, or replacing it.",
86
- inputSchema: { day, from: z.string(), to: z.string(), replace: z.boolean().optional() },
91
+ inputSchema: {
92
+ day,
93
+ from: z.string(),
94
+ to: z.string(),
95
+ replace: z.boolean().optional().describe("Take the first service's music instead of the second's."),
96
+ add: z.boolean().optional().describe("Put the first service's music after the second's. One of the two is needed when the second has music."),
97
+ preview,
98
+ },
87
99
  annotations: WRITE,
88
- }, ({ day: when, from, to, replace }) => reply(() => tasks.copy(api, { when, from, to, replace })));
100
+ }, ({ day: when, from, to, replace, add, preview: look }) => reply(() => tasks.copy(api, { when, from, to, replace, add, preview: look })));
89
101
  server.registerTool('api_calls', {
90
102
  description: 'Every call the Hymnkeep API offers, by name, for what the other tools do not cover. Filter by words in the name or summary.',
91
103
  inputSchema: { search: z.string().optional() },
@@ -98,15 +110,46 @@ export function build(api) {
98
110
  };
99
111
  }));
100
112
  server.registerTool('api_call', {
101
- description: 'Make one API call by name (see api_calls), with its ids and fields in params. A call whose method is not GET writes: say what it will change first.',
102
- inputSchema: { name: z.string(), params: z.record(z.string(), z.unknown()).optional() },
113
+ description: 'Make one API call by name (see api_calls), with its ids and fields in params. A field that takes a file takes {"file": "<path on this computer>"}. A call whose method is not GET writes: use preview first and show the person.',
114
+ inputSchema: { name: z.string(), params: z.record(z.string(), z.unknown()).optional(), preview },
103
115
  annotations: WRITE,
104
- }, ({ name, params }) => reply(async () => {
105
- const data = await call(api, operation(name), params ?? {});
106
- return { data, text: `${name} done.` };
116
+ }, ({ name, params, preview: look }) => reply(async () => {
117
+ const laid = request(operation(name), withFiles(params ?? {}));
118
+ if (look) {
119
+ return { data: laid, text: describe(laid, api.base) };
120
+ }
121
+ return { data: await send(api, laid), text: `${name} done.` };
107
122
  }));
123
+ server.registerTool('upload_file', {
124
+ description: "Upload a PDF or MP3 (up to 64 MB) from this computer to a piece in the library: on the piece, or on its tune, its text or one book's printing, with the parts it holds.",
125
+ inputSchema: {
126
+ path: z.string().describe('The file on this computer.'),
127
+ piece: z.string().describe('The piece in the library, by title or id.'),
128
+ place: z.string().optional().describe("Where on the piece: the tune, the text, or a book's printing, by name. The piece itself if left out."),
129
+ parts: z.array(z.string()).optional().describe('Parts the file holds, by name ("Melody", "SATB").'),
130
+ preview,
131
+ },
132
+ annotations: WRITE,
133
+ }, ({ path, piece, place, parts, preview: look }) => reply(() => tasks.upload(api, { files: [path], piece, place, parts, preview: look })));
108
134
  return server;
109
135
  }
136
+ /** `{"file": "<path>"}` in a call's params is a file to send. */
137
+ function withFiles(params) {
138
+ const walk = (value) => {
139
+ if (Array.isArray(value)) {
140
+ return value.map(walk);
141
+ }
142
+ if (value && typeof value === 'object') {
143
+ const entries = Object.entries(value);
144
+ if (entries.length === 1 && entries[0][0] === 'file' && typeof entries[0][1] === 'string') {
145
+ return new Upload(entries[0][1]);
146
+ }
147
+ return Object.fromEntries(entries.map(([key, each]) => [key, walk(each)]));
148
+ }
149
+ return value;
150
+ };
151
+ return walk(params);
152
+ }
110
153
  export async function serve(api) {
111
154
  await build(api).connect(new StdioServerTransport());
112
155
  }
@@ -1,6 +1,7 @@
1
1
  import { readFileSync } from 'node:fs';
2
2
  import { dirname, join } from 'node:path';
3
3
  import { fileURLToPath } from 'node:url';
4
+ import { fit, flatten, hasUpload, Upload } from './params.js';
4
5
  const PREFIX = '/api/p/{community}';
5
6
  let cached = null;
6
7
  /** Every call, read from the description that ships beside the program. */
@@ -18,7 +19,8 @@ export function operations() {
18
19
  tag: op.tags[0] ?? '',
19
20
  pathParams: (op.parameters ?? []).filter((p) => p.in === 'path' && p.name !== 'community').map((p) => p.name),
20
21
  queryParams: (op.parameters ?? []).filter((p) => p.in === 'query').map((p) => ({ name: p.name.replace(/\[\]$/, ''), required: p.required, schema: p.schema })),
21
- body: op.requestBody?.content['application/json'].schema ?? null,
22
+ body: op.requestBody ? (Object.values(op.requestBody.content)[0]?.schema ?? null) : null,
23
+ form: op.requestBody?.content['multipart/form-data'] !== undefined,
22
24
  writes: method !== 'get',
23
25
  })));
24
26
  return cached;
@@ -31,10 +33,12 @@ export function operation(id) {
31
33
  return found;
32
34
  }
33
35
  /**
34
- * Makes one call: the path's ids from `params`, the rest as the query of a
35
- * read or the body of a write.
36
+ * Lays one call out: the path's ids from `params`, then each field where the
37
+ * description puts it, in the query or the body. A field the description
38
+ * does not know goes in the query of a read and the body of a write. A body
39
+ * with a file in it goes as a form.
36
40
  */
37
- export async function call(api, op, params) {
41
+ export function request(op, params) {
38
42
  const rest = { ...params };
39
43
  let path = op.path;
40
44
  for (const name of op.pathParams) {
@@ -45,8 +49,68 @@ export async function call(api, op, params) {
45
49
  path = path.replace(`{${name}}`, encodeURIComponent(String(value)));
46
50
  delete rest[name];
47
51
  }
48
- if (!op.writes || op.method === 'DELETE') {
49
- return api.request(op.method, path, { query: rest });
52
+ const query = {};
53
+ const body = {};
54
+ const fields = (op.body?.properties ?? {});
55
+ for (const [name, value] of Object.entries(rest)) {
56
+ const inQuery = op.queryParams.find((param) => param.name === name);
57
+ if (inQuery) {
58
+ query[name] = fit(value, inQuery.schema);
59
+ }
60
+ else if (name in fields || (op.writes && op.method !== 'DELETE') || op.body !== null) {
61
+ body[name] = fit(value, fields[name]);
62
+ }
63
+ else {
64
+ query[name] = value;
65
+ }
66
+ }
67
+ const hasBody = op.body !== null || Object.keys(body).length > 0;
68
+ return {
69
+ method: op.method,
70
+ path,
71
+ query: flatten(query).map(([name, value]) => [name, value instanceof Upload ? value.path : value]),
72
+ body: hasBody ? body : null,
73
+ form: op.form || hasUpload(body),
74
+ };
75
+ }
76
+ /** Sends a call laid out by `request`. */
77
+ export function send(api, laid) {
78
+ if (laid.form && laid.body) {
79
+ const form = new FormData();
80
+ for (const [name, value] of flatten(laid.body)) {
81
+ if (value instanceof Upload) {
82
+ form.append(name, value.blob(), value.name);
83
+ }
84
+ else {
85
+ form.append(name, value);
86
+ }
87
+ }
88
+ // A form only goes by POST; Laravel reads PATCH and PUT forms through `_method`.
89
+ if (laid.method !== 'POST') {
90
+ form.append('_method', laid.method);
91
+ }
92
+ return api.request('POST', laid.path, { query: laid.query, form });
93
+ }
94
+ return api.request(laid.method, laid.path, { query: laid.query, body: laid.body ?? undefined });
95
+ }
96
+ /** What a call would send, for a person to read before it is sent. */
97
+ export function describe(laid, base = '') {
98
+ const query = laid.query.length ? `?${laid.query.map(([n, v]) => `${n}=${encodeURIComponent(v)}`).join('&')}` : '';
99
+ const lines = [`Would send ${laid.method} ${base}${laid.path}${query}`];
100
+ if (laid.body) {
101
+ if (laid.form) {
102
+ for (const [name, value] of flatten(laid.body)) {
103
+ lines.push(value instanceof Upload ? ` ${name}: the file ${value.path} (${Math.ceil(value.size / 1024)} KB, ${value.type})` : ` ${name}: ${value}`);
104
+ }
105
+ }
106
+ else {
107
+ lines.push(JSON.stringify(laid.body, null, 2).replace(/^/gm, ' '));
108
+ }
50
109
  }
51
- return api.request(op.method, path, { body: rest });
110
+ lines.push('Nothing was sent.');
111
+ return lines.join('\n');
112
+ }
113
+ /** Makes one call. */
114
+ export function call(api, op, params) {
115
+ return send(api, request(op, params));
52
116
  }
package/dist/params.js ADDED
@@ -0,0 +1,173 @@
1
+ import { readFileSync, statSync } from 'node:fs';
2
+ import { basename, extname } from 'node:path';
3
+ /** A file named on the command line as `field=@path`, read only when it is sent. */
4
+ export class Upload {
5
+ path;
6
+ constructor(path) {
7
+ this.path = path;
8
+ }
9
+ get name() {
10
+ return basename(this.path);
11
+ }
12
+ get size() {
13
+ return statSync(this.path).size;
14
+ }
15
+ get type() {
16
+ return { '.pdf': 'application/pdf', '.mp3': 'audio/mpeg' }[extname(this.path).toLowerCase()] ?? 'application/octet-stream';
17
+ }
18
+ blob() {
19
+ return new Blob([readFileSync(this.path)], { type: this.type });
20
+ }
21
+ toJSON() {
22
+ return `@${this.path}`;
23
+ }
24
+ }
25
+ /**
26
+ * Reads `name=value` pairs as the old HQ tool did: `key=text`, `key:=<json>`
27
+ * for a number, true, null or a list, `a[b]=value` for a nested field,
28
+ * `a[]=value` to add to a list, and `file=@path` for a file to upload.
29
+ */
30
+ export function parsePairs(pairs, into = {}) {
31
+ for (const pair of pairs) {
32
+ const json = pair.match(/^([^=:]+):=(.*)$/s);
33
+ const text = json ? null : pair.match(/^([^=]+)=(.*)$/s);
34
+ if (!json && !text) {
35
+ throw new Error(`"${pair}" needs a value: name=value, or name:=<json> for a number, true or a list.`);
36
+ }
37
+ const [, key, raw] = (json ?? text);
38
+ let value;
39
+ if (json) {
40
+ try {
41
+ value = JSON.parse(raw);
42
+ }
43
+ catch {
44
+ throw new Error(`"${key}:=" takes JSON, and ${raw} is not JSON. For text, write ${key}=${raw}.`);
45
+ }
46
+ }
47
+ else {
48
+ value = raw.startsWith('@') && raw.length > 1 ? upload(raw.slice(1)) : raw;
49
+ }
50
+ place(into, path(key), value);
51
+ }
52
+ return into;
53
+ }
54
+ function upload(file) {
55
+ try {
56
+ statSync(file);
57
+ }
58
+ catch {
59
+ throw new Error(`There is no file at ${file}.`);
60
+ }
61
+ return new Upload(file);
62
+ }
63
+ /** `a[b][]` → ['a', 'b', '']. */
64
+ function path(key) {
65
+ const match = key.match(/^([^[\]]+)((?:\[[^[\]]*\])*)$/);
66
+ if (!match) {
67
+ throw new Error(`"${key}" is not a field name: write a, a[b] or a[].`);
68
+ }
69
+ return [match[1], ...[...match[2].matchAll(/\[([^[\]]*)\]/g)].map((m) => m[1])];
70
+ }
71
+ function place(into, keys, value) {
72
+ const [head, ...rest] = keys;
73
+ const container = into;
74
+ const at = Array.isArray(into) && /^\d+$/.test(head) ? Number(head) : head;
75
+ if (rest.length === 0) {
76
+ if (head === '' && Array.isArray(into)) {
77
+ into.push(value);
78
+ }
79
+ else {
80
+ container[at] = value;
81
+ }
82
+ return;
83
+ }
84
+ // `a[]` and `a[0]` make a list; any other name makes an object.
85
+ const next = rest[0] === '' || /^\d+$/.test(rest[0]) ? [] : {};
86
+ if (head === '' && Array.isArray(into)) {
87
+ into.push(next);
88
+ place(next, rest, value);
89
+ return;
90
+ }
91
+ const slot = container;
92
+ if (slot[at] === undefined || typeof slot[at] !== 'object' || slot[at] === null) {
93
+ slot[at] = next;
94
+ }
95
+ place(slot[at], rest, value);
96
+ }
97
+ const typeOf = (schema) => (schema?.type === undefined ? [] : Array.isArray(schema.type) ? schema.type : [schema.type]);
98
+ /**
99
+ * Fits what was typed to what the call takes: one value where a list is
100
+ * wanted becomes a list of one, and "true", "false" and numbers typed as
101
+ * text become what the field expects.
102
+ */
103
+ export function fit(value, schema) {
104
+ if (schema === undefined || value === null || value instanceof Upload) {
105
+ return value;
106
+ }
107
+ const types = typeOf(schema);
108
+ if (types.includes('array') && !Array.isArray(value)) {
109
+ return [fit(value, schema.items)];
110
+ }
111
+ if (Array.isArray(value)) {
112
+ return value.map((each) => fit(each, schema.items));
113
+ }
114
+ if (typeof value === 'object') {
115
+ return Object.fromEntries(Object.entries(value).map(([key, each]) => [key, fit(each, schema.properties?.[key])]));
116
+ }
117
+ if (typeof value === 'string') {
118
+ // A yes-or-no in a query is described as 1 or 0.
119
+ if (schema.enum?.includes(1) && schema.enum.includes(0) && /^(true|false|yes|no)$/i.test(value)) {
120
+ return /^(true|yes)$/i.test(value) ? 1 : 0;
121
+ }
122
+ if (types.includes('boolean') && !types.includes('string') && /^(true|false|1|0|yes|no)$/i.test(value)) {
123
+ return /^(true|1|yes)$/i.test(value);
124
+ }
125
+ if ((types.includes('integer') || types.includes('number')) && !types.includes('string') && value.trim() !== '' && Number.isFinite(Number(value))) {
126
+ return Number(value);
127
+ }
128
+ }
129
+ return value;
130
+ }
131
+ export function hasUpload(value) {
132
+ if (value instanceof Upload) {
133
+ return true;
134
+ }
135
+ if (Array.isArray(value)) {
136
+ return value.some(hasUpload);
137
+ }
138
+ return typeof value === 'object' && value !== null && Object.values(value).some(hasUpload);
139
+ }
140
+ /**
141
+ * Flattens a value into bracketed names, `a[0]`, `a[b]`, as Laravel reads a
142
+ * query string or a form. True and false go as 1 and 0, which is the only
143
+ * spelling its boolean rule takes outside JSON.
144
+ */
145
+ export function flatten(values) {
146
+ const out = [];
147
+ const walk = (name, value) => {
148
+ if (value === null || value === undefined) {
149
+ out.push([name, '']);
150
+ }
151
+ else if (value instanceof Upload) {
152
+ out.push([name, value]);
153
+ }
154
+ else if (Array.isArray(value)) {
155
+ value.forEach((each, index) => walk(`${name}[${index}]`, each));
156
+ }
157
+ else if (typeof value === 'object') {
158
+ for (const [key, each] of Object.entries(value)) {
159
+ walk(`${name}[${key}]`, each);
160
+ }
161
+ }
162
+ else if (typeof value === 'boolean') {
163
+ out.push([name, value ? '1' : '0']);
164
+ }
165
+ else {
166
+ out.push([name, String(value)]);
167
+ }
168
+ };
169
+ for (const [key, value] of Object.entries(values)) {
170
+ walk(key, value);
171
+ }
172
+ return out;
173
+ }