@verbatims/cli 0.1.18 → 1.0.1

package/README.md

@@ -2,6 +2,8 @@
 
 CLI for the [Verbatims](https://verbatims.cc) quotes API.
 
+Version 1 uses normalized provenance options for quote creation and updates.
+
 ## Install
 
 ```bash
@@ -27,12 +29,12 @@ verbatims quotes get 123 --format json
 verbatims quotes attributions list 123
 verbatims quotes attributions create 123 --author-id 1 --reference-id 2 --status manually_verified --primary
 verbatims quotes sources list 123
-verbatims quotes sources create 123 --source-type book --source-url https://example.com/edition --status externally_verified
+verbatims quotes sources create 123 --attribution-id 7 --source-type book --source-url https://example.com/edition --status externally_verified
 
 # Create a quote with a source
-verbatims quotes create --source-type book --source-url https://example.com/edition
+verbatims quotes create --name "Alea jacta est" --author-id 1 --source-type book --source-url https://example.com/edition
 
-The quote-level `--author-id`, `--reference-id`, `--source-type`, and `--source-url` options are deprecated compatibility options. New integrations should use the SDK `provenance` payload; the dedicated `quotes attributions` and `quotes sources` commands manage secondary provenance.
+Use `--author-id` or `--reference-id` to create the required primary attribution. Sources always require `--attribution-id`; use the dedicated `quotes attributions` and `quotes sources` commands for additional or edited provenance.
 
 # Browse interactively
 verbatims quotes browse

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@verbatims/cli",
-  "version": "0.1.18",
+  "version": "1.0.1",
   "description": "CLI for the Verbatims quotes API",
   "type": "module",
   "bin": {
@@ -16,7 +16,7 @@
     "typecheck": "tsc --noEmit"
   },
   "dependencies": {
-    "@verbatims/sdk": "^1.0.0",
+    "@verbatims/sdk": "^2.0.1",
     "@clack/prompts": "^0.10.1",
     "chalk": "^5.4.1",
     "commander": "^13.1.0",

package/src/commands/quotes.ts

@@ -10,13 +10,6 @@ function getFormat(program: Command): Format {
   return (program.opts().format ?? 'table') as Format
 }
 
-function warnLegacyQuoteOptions(options: Record<string, unknown>): void {
-  const fields = ['authorId', 'referenceId', 'sourceType', 'sourceUrl']
-  if (fields.some(field => options[field] !== undefined)) {
-    console.error(chalk.yellow('Warning: quote provenance options are deprecated; use the provenance API fields instead.'))
-  }
-}
-
 export function registerQuotesCommand(program: Command) {
   const quotes = program.command('quotes').description('Manage quotes')
 
@@ -73,14 +66,13 @@ export function registerQuotesCommand(program: Command) {
     .description('Create a quote')
     .option('--name <text>', 'Quote text')
     .option('--language <lang>', 'Language')
-    .option('--author-id <id>', 'Author ID (deprecated)')
-    .option('--reference-id <id>', 'Reference ID (deprecated)')
-    .option('--source-type <type>', 'Source type (deprecated)')
-    .option('--source-url <url>', 'Source URL (deprecated)')
+    .option('--author-id <id>', 'Primary attribution author ID')
+    .option('--reference-id <id>', 'Primary attribution reference ID')
+    .option('--source-type <type>', 'Source type for the primary attribution')
+    .option('--source-url <url>', 'Source URL for the primary attribution')
     .action(async (options: Record<string, string>) => {
       const client = await getClient()
       const format = getFormat(program)
-      warnLegacyQuoteOptions(options)
 
       const name = options.name ?? await text({ message: 'Quote text', validate: (v) => !v ? 'Required' : undefined })
       if (isCancel(name)) cancel('Cancelled')
@@ -90,20 +82,29 @@ export function registerQuotesCommand(program: Command) {
 
       const authorId = options.authorId ? Number(options.authorId) : undefined
       const referenceId = options.referenceId ? Number(options.referenceId) : undefined
+      if (authorId === undefined && referenceId === undefined) {
+        throw new Error('A quote requires --author-id or --reference-id')
+      }
 
       const { data } = await withSpinner('Creating quote', () =>
         client.quotes.create({
           content: name as string,
           name: name as string,
           language: language as string,
-          provenance: {
-            author_id: authorId,
-            reference_id: referenceId,
-            source: options.sourceType ? { source_type: options.sourceType, source_url: options.sourceUrl } : undefined,
-          },
+          attributions: [{ author_id: authorId, reference_id: referenceId, is_primary: true }],
         }),
         format,
       )
+      if (options.sourceType && data) {
+        const primary = data.attributions?.find(attribution => attribution.is_primary)
+        if (!primary) throw new Error('The created quote has no primary attribution')
+        await withSpinner('Creating source', () => client.quotes.createSource(data.id, {
+          attribution_id: primary.id,
+          source_type: options.sourceType,
+          source_url: options.sourceUrl,
+          is_primary: true,
+        }), format)
+      }
       console.log(chalk.green(' Quote created'))
       output(data, format)
     })
@@ -113,28 +114,28 @@ export function registerQuotesCommand(program: Command) {
     .description('Update a quote')
     .option('--name <text>', 'Quote text')
     .option('--language <lang>', 'Language')
-    .option('--author-id <id>', 'Author ID (deprecated)')
-    .option('--reference-id <id>', 'Reference ID (deprecated)')
-    .option('--source-type <type>', 'Source type (deprecated)')
-    .option('--source-url <url>', 'Source URL (deprecated)')
+    .option('--author-id <id>', 'Primary attribution author ID')
+    .option('--reference-id <id>', 'Primary attribution reference ID')
     .action(async (id: string, options: Record<string, string>) => {
       const client = await getClient()
       const format = getFormat(program)
-      warnLegacyQuoteOptions(options)
 
       const data_: Record<string, unknown> = {}
       if (options.name) { data_.name = options.name; data_.content = options.name }
       if (options.language) data_.language = options.language
-      if (options.authorId !== undefined) data_.provenance = { ...(data_.provenance as object), author_id: options.authorId === 'null' ? null : Number(options.authorId) }
-      if (options.referenceId !== undefined) data_.provenance = { ...(data_.provenance as object), reference_id: options.referenceId === 'null' ? null : Number(options.referenceId) }
-      if (options.sourceType !== undefined || options.sourceUrl !== undefined) {
-        data_.provenance = {
-          ...(data_.provenance as object),
-          source: { source_type: options.sourceType ?? 'manual', source_url: options.sourceUrl },
-        }
-      }
+      const authorId = options.authorId === undefined ? undefined : options.authorId === 'null' ? null : Number(options.authorId)
+      const referenceId = options.referenceId === undefined ? undefined : options.referenceId === 'null' ? null : Number(options.referenceId)
 
       const { data } = await withSpinner('Updating quote', () => client.quotes.update(Number(id), data_ as any), format)
+      if (authorId !== undefined || referenceId !== undefined) {
+        const attributions = await client.quotes.listAttributions(Number(id))
+        const primary = attributions.data?.find(attribution => attribution.is_primary)
+        if (!primary) throw new Error('The quote has no primary attribution')
+        await withSpinner('Updating primary attribution', () => client.quotes.updateAttribution(Number(id), primary.id, {
+          author_id: authorId === undefined ? primary.author_id : authorId,
+          reference_id: referenceId === undefined ? primary.reference_id : referenceId,
+        }), format)
+      }
       console.log(chalk.green(' Quote updated'))
       output(data, format)
     })
@@ -306,8 +307,9 @@ export function registerQuotesCommand(program: Command) {
       }
       if (action === 'create') {
         if (!options.sourceType) throw new Error('--source-type is required')
+        if (!options.attributionId) throw new Error('--attribution-id is required')
         const { data } = await withSpinner('Creating source', () => client.quotes.createSource(id, {
-          attribution_id: options.attributionId ? Number(options.attributionId) : null,
+          attribution_id: Number(options.attributionId),
           source_type: options.sourceType,
           source_url: options.sourceUrl,
           label: options.label,