yanki 0.7.1 → 0.8.0

package/dist/bin/cli.js

@@ -1,10 +1,10 @@
 #!/usr/bin/env node
-var Y=Object.defineProperty;var m=(e,t)=>Y(e,"name",{value:t,configurable:!0});import{y as J,u as h,k as T,j as D,l as I,b as M,c as U,f as L,s as z,h as j}from"../sync-B_u0fKEU.js";import s from"chalk";import{globby as H}from"globby";import W from"node:fs/promises";import q from"node:path";import B from"node:os";import F from"yargs";import{hideBin as G}from"yargs/helpers";import"rehype-mathjax";import"rehype-parse";import"node:crypto";var K="0.7.1";const N=process?.versions?.node!==void 0,d={verbose:!1,log(...e){if(!this.verbose)return;const t=s.gray("[Log]");N?console.warn(t,...e):console.log(t,...e)},logPrefixed(e,...t){this.info(s.blue(`[${e}]`),...t)},info(...e){if(!this.verbose)return;const t=s.green("[Info]");N?console.warn(t,...e):console.info(t,...e)},infoPrefixed(e,...t){this.info(s.blue(`[${e}]`),...t)},warn(...e){console.warn(s.yellow("[Warning]"),...e)},warnPrefixed(e,...t){this.warn(s.blue(`[${e}]`),...t)},error(...e){console.error(s.red("[Error]"),...e)},errorPrefixed(e,...t){this.error(s.blue(`[${e}]`),...t)}},y={"anki-auto-launch":{alias:"l",default:!1,describe:"Attempt to open the Anki desktop app if it's not already running. (Experimental, macOS only.)",type:"boolean"}},g={"anki-web":{alias:"w",default:!0,describe:'Automatically sync any changes to AnkiWeb after Yanki has finished syncing locally. If false, only local Anki data is updated and you must manually invoke a sync to AnkiWeb. This is the equivalent of pushing the "sync" button in the Anki app.',type:"boolean"}},w={"anki-connect":{default:"http://127.0.0.1:8765",describe:"Host and port of the Anki-Connect server. The default is usually fine. See the Anki-Connect documentation for more information.",type:"string"}},v={verbose:{default:!1,describe:"Enable verbose logging.",type:"boolean"}};function k(e){return{json:{default:!1,describe:e,type:"boolean"}}}m(k,"jsonOption");const S={"dry-run":{alias:"d",default:!1,describe:"Run without making any changes to the Anki database. See a report of what would have been done.",type:"boolean"}};function A(e){return{namespace:{alias:"n",default:J,describe:e,type:"string"}}}m(A,"namespaceOption");const x=B.homedir();function Q(e){if(typeof e!="string")throw new TypeError(`Expected a string, got ${typeof e}`);return x?e.replace(/^~(?=$|\/|\\)/,x):e}m(Q,"untildify");const b=m(e=>{const{code:t}=e.cause;throw t==="ECONNREFUSED"&&(d.error("Failed to connect to Anki. Make sure Anki is running and AnkiConnect is installed."),process.exitCode=1,process.exit()),e instanceof Error?e:new Error("Unknown error")},"ankiNotRunningErrorHandler"),R=F(G(process.argv));await R.scriptName("yanki").usage("$0 [command]","Run a Yanki command. Defaults to `sync` if a command is not provided.").command(["$0 <directory> [options]","sync <directory> [options]"],"Perform a one-way synchronization from a local directory of Markdown files to the Anki database. Any Markdown files in subdirectories are included as well.",e=>e.positional("directory",{demandOption:!0,describe:"The path to the local directory of Markdown files to sync.",type:"string"}).option(S).option(A("Advanced option for managing multiple Yanki synchronization groups. Case insensitive. See the readme for more information.")).option(w).option(y).option(g).option("manage-filenames",{alias:"m",choices:["off","prompt","response"],default:"off",describe:'Rename local note files to match their content. Useful if you want to feel have semantically reasonable note file names without managing them by hand. The `"prompt"` option will attempt to create the filename based on the "front" of the card, while `"response"` will prioritize the "back", "Cloze", or "type in the answer" portions of the card. Truncation, sanitization, and deduplication are taken care of.',type:"string"}).option("max-filename-length",{default:void 0,defaultDescription:"60",describe:"If `manage-filenames` is enabled, this option specifies the maximum length of the filename in characters.",type:"number"}).option(k("Output the sync report as JSON.")).option(v),async({ankiAutoLaunch:e,ankiConnect:t,ankiWeb:i,directory:n,dryRun:a,json:r,manageFilenames:o,maxFilenameLength:p,namespace:f,recursive:c=!0,verbose:u})=>{d.verbose=u;const l=Q(n),E=c?`${l}/**/*.md`:`${l}/*.md`,C=await H(E,{absolute:!0});if(C.length===0){d.error(`No Markdown files found in "${l}".`),process.exitCode=1;return}o==="off"&&p!==void 0&&d.warn("Ignoring `max-filename-length` option because `manage-filenames` is not enabled.");const{host:$,port:P}=h(t),O=await T(C,{ankiConnectOptions:{autoLaunch:e,host:$,port:P},ankiWeb:i,dryRun:a,filenameMode:o==="off"?void 0:o,manageFilenames:o!=="off",maxFilenameLength:p,namespace:f}).catch(b);r?(process.stdout.write(JSON.stringify(O,void 0,2)),process.stdout.write(`
-`)):(process.stderr.write(D(O,u)),process.stderr.write(`
-`))}).command("list [options]","Utility command to list Yanki-created notes in the Anki database.",e=>e.option(A("Advanced option to list notes in a specific namespace. Case insensitive. Notes from the default internal namespace are listed by default. Pass `'*'` to list all Yanki-created notes in the Anki database.")).options(w).options(y).option(k("Output the list of notes as JSON to stdout.")),async({ankiAutoLaunch:e,ankiConnect:t,json:i,namespace:n})=>{const{host:a,port:r}=h(t),o=await I({ankiConnectOptions:{autoLaunch:e,host:a,port:r},namespace:n}).catch(b);i?(process.stdout.write(JSON.stringify(o,void 0,2)),process.stdout.write(`
-`)):(process.stdout.write(M(o)),process.stdout.write(`
-`))}).command("delete [options]","Utility command to manually delete Yanki-created notes in the Anki database. This is for advanced use cases, usually the `sync` command takes care of deleting files from Anki Database once they're removed from the local file system.",e=>e.option(S).option(A("Advanced option to list notes in a specific namespace. Case insensitive. Notes from the default internal namespace are listed by default. If you've synced notes to multiple namespaces, Pass `'*'` to delete all Yanki-created notes in the Anki database.")).options(w).options(y).option(g).option(k("Output the list of deleted notes as JSON to stdout.")).option(v),async({ankiAutoLaunch:e,ankiConnect:t,ankiWeb:i,dryRun:n,json:a,namespace:r,verbose:o})=>{const{host:p,port:f}=h(t),c=await U({ankiConnectOptions:{autoLaunch:e,host:p,port:f},ankiWeb:i,dryRun:n,namespace:r}).catch(b);a?(process.stdout.write(JSON.stringify(c,void 0,2)),process.stdout.write(`
-`)):(process.stderr.write(L(c,o)),process.stderr.write(`
-`))}).command("style [options]","Utility command to set the CSS stylesheet for all present and future Yanki-created notes.",e=>e.option(S).option("css",{alias:"c",default:void 0,describe:"Path to the CSS stylesheet to set for all Yanki-created notes. If not provided, the default Anki stylesheet is used.",type:"string"}).options(w).options(y).option(g).option(k("Output the list of updated note types / models as JSON to stdout.")).option(v),async({ankiAutoLaunch:e,ankiConnect:t,ankiWeb:i,css:n,dryRun:a,json:r,verbose:o})=>{const{host:p,port:f}=h(t);let c;if(n!==void 0){if(q.extname(n)!==".css"){d.error("The provided CSS file must have a .css extension."),process.exitCode=1;return}try{c=await W.readFile(n,"utf8")}catch(l){l instanceof Error?d.error(`Error loading CSS file: ${l.message}`):d.error(`Unknown error loading CSS file: ${String(l)}`),process.exitCode=1;return}}const u=await z({ankiConnectOptions:{autoLaunch:e,host:p,port:f},ankiWeb:i,css:c??void 0,dryRun:a}).catch(b);r?(process.stdout.write(JSON.stringify(u,void 0,2)),process.stdout.write(`
-`)):(process.stderr.write(j(u,o)),process.stderr.write(`
-`))}).demandCommand(1).alias("h","help").version(K).alias("v","version").help().wrap(process.stdout.isTTY?Math.min(120,R.terminalWidth()):0).parse();
+var J=Object.defineProperty;var u=(e,t)=>J(e,"name",{value:t,configurable:!0});import{t as h,u as y,n as M,m as I,l as L,b as U,c as D,f as z,s as F,i as H}from"../sync-files-norUev7R.js";import s from"chalk";import{globby as j}from"globby";import W from"node:fs/promises";import q from"node:path";import B from"node:os";import G from"yargs";import{hideBin as K}from"yargs/helpers";import"rehype-mathjax";import"rehype-parse";import"node:crypto";var Q="0.8.0";const R=process?.versions?.node!==void 0,c={verbose:!1,log(...e){if(!this.verbose)return;const t=s.gray("[Log]");R?console.warn(t,...e):console.log(t,...e)},logPrefixed(e,...t){this.info(s.blue(`[${e}]`),...t)},info(...e){if(!this.verbose)return;const t=s.green("[Info]");R?console.warn(t,...e):console.info(t,...e)},infoPrefixed(e,...t){this.info(s.blue(`[${e}]`),...t)},warn(...e){console.warn(s.yellow("[Warning]"),...e)},warnPrefixed(e,...t){this.warn(s.blue(`[${e}]`),...t)},error(...e){console.error(s.red("[Error]"),...e)},errorPrefixed(e,...t){this.error(s.blue(`[${e}]`),...t)}},g={"anki-auto-launch":{alias:"l",default:!1,describe:"Attempt to open the Anki desktop app if it's not already running. (Experimental, macOS only.)",type:"boolean"}},A={"anki-web":{alias:"w",default:!0,describe:'Automatically sync any changes to AnkiWeb after Yanki has finished syncing locally. If false, only local Anki data is updated and you must manually invoke a sync to AnkiWeb. This is the equivalent of pushing the "sync" button in the Anki app.',type:"boolean"}},w={"anki-connect":{default:"http://127.0.0.1:8765",describe:"Host and port of the Anki-Connect server. The default is usually fine. See the Anki-Connect documentation for more information.",type:"string"}},S={verbose:{default:!1,describe:"Enable verbose logging.",type:"boolean"}};function b(e){return{json:{default:!1,describe:e,type:"boolean"}}}u(b,"jsonOption");const C={"dry-run":{alias:"d",default:!1,describe:"Run without making any changes to the Anki database. See a report of what would have been done.",type:"boolean"}};function O(e){return{namespace:{alias:"n",default:h.namespace,describe:e,type:"string"}}}u(O,"namespaceOption");const E=B.homedir();function V(e){if(typeof e!="string")throw new TypeError(`Expected a string, got ${typeof e}`);return E?e.replace(/^~(?=$|\/|\\)/,E):e}u(V,"untildify");const k=u(e=>{const{code:t}=e.cause;throw t==="ECONNREFUSED"&&(c.error("Failed to connect to Anki. Make sure Anki is running and AnkiConnect is installed."),process.exitCode=1,process.exit()),e instanceof Error?e:new Error("Unknown error")},"ankiNotRunningErrorHandler"),$=G(K(process.argv));await $.scriptName("yanki").usage("$0 [command]","Run a Yanki command. Defaults to `sync` if a command is not provided.").command(["$0 <directory> [options]","sync <directory> [options]"],"Perform a one-way synchronization from a local directory of Markdown files to the Anki database. Any Markdown files in subdirectories are included as well.",e=>e.positional("directory",{demandOption:!0,describe:"The path to the local directory of Markdown files to sync.",type:"string"}).option(C).option(O("Advanced option for managing multiple Yanki synchronization groups. Case insensitive. See the readme for more information.")).option(w).option(g).option(A).option("manage-filenames",{alias:"m",choices:["off","prompt","response"],default:h.manageFilenames,describe:'Rename local note files to match their content. Useful if you want to feel have semantically reasonable note file names without managing them by hand. The `"prompt"` option will attempt to create the filename based on the "front" of the card, while `"response"` will prioritize the "back", "Cloze", or "type in the answer" portions of the card. Truncation, sanitization, and deduplication are taken care of.',type:"string"}).option("max-filename-length",{default:void 0,defaultDescription:String(h.maxFilenameLength),describe:"If `manage-filenames` is enabled, this option specifies the maximum length of the filename in characters.",type:"number"}).option("sync-media",{alias:"s",choices:["off","all","local","remote"],default:h.syncMediaAssets,describe:"Sync image, video, and audio assets to Anki's media storage system. Clean up is managed automatically. The `all` argument will save both local and remote assets to Anki, while `local` will only save local assets, `remote` will only save remote assets, and `off` will not save any assets.",type:"string"}).option(b("Output the sync report as JSON.")).option(S),async({ankiAutoLaunch:e,ankiConnect:t,ankiWeb:i,directory:o,dryRun:a,json:r,manageFilenames:n,maxFilenameLength:d,namespace:f,recursive:l=!0,syncMedia:m,verbose:p})=>{c.verbose=p;const v=V(o),P=l?`${v}/**/*.md`:`${v}/*.md`,x=await j(P,{absolute:!0});if(x.length===0){c.error(`No Markdown files found in "${v}".`),process.exitCode=1;return}n==="off"&&d!==void 0&&c.warn("Ignoring `max-filename-length` option because `manage-filenames` is not enabled.");const{host:Y,port:T}=y(t),N=await M(x,{ankiConnectOptions:{autoLaunch:e,host:Y,port:T},ankiWeb:i,dryRun:a,manageFilenames:n,maxFilenameLength:d,namespace:f,syncMediaAssets:m}).catch(k);r?(process.stdout.write(JSON.stringify(N,void 0,2)),process.stdout.write(`
+`)):(process.stderr.write(I(N,p)),process.stderr.write(`
+`))}).command("list [options]","Utility command to list Yanki-created notes in the Anki database.",e=>e.option(O("Advanced option to list notes in a specific namespace. Case insensitive. Notes from the default internal namespace are listed by default. Pass `'*'` to list all Yanki-created notes in the Anki database.")).options(w).options(g).option(b("Output the list of notes as JSON to stdout.")),async({ankiAutoLaunch:e,ankiConnect:t,json:i,namespace:o})=>{const{host:a,port:r}=y(t),n=await L({ankiConnectOptions:{autoLaunch:e,host:a,port:r},namespace:o}).catch(k);i?(process.stdout.write(JSON.stringify(n,void 0,2)),process.stdout.write(`
+`)):(process.stdout.write(U(n)),process.stdout.write(`
+`))}).command("delete [options]","Utility command to manually delete Yanki-created notes in the Anki database. This is for advanced use cases, usually the `sync` command takes care of deleting files from Anki Database once they're removed from the local file system.",e=>e.option(C).option(O("Advanced option to list notes in a specific namespace. Case insensitive. Notes from the default internal namespace are listed by default. If you've synced notes to multiple namespaces, Pass `'*'` to delete all Yanki-created notes in the Anki database.")).options(w).options(g).option(A).option(b("Output the list of deleted notes as JSON to stdout.")).option(S),async({ankiAutoLaunch:e,ankiConnect:t,ankiWeb:i,dryRun:o,json:a,namespace:r,verbose:n})=>{const{host:d,port:f}=y(t),l=await D({ankiConnectOptions:{autoLaunch:e,host:d,port:f},ankiWeb:i,dryRun:o,namespace:r}).catch(k);a?(process.stdout.write(JSON.stringify(l,void 0,2)),process.stdout.write(`
+`)):(process.stderr.write(z(l,n)),process.stderr.write(`
+`))}).command("style [options]","Utility command to set the CSS stylesheet for all present and future Yanki-created notes.",e=>e.option(C).option("css",{alias:"c",default:void 0,describe:"Path to the CSS stylesheet to set for all Yanki-created notes. If not provided, the default Anki stylesheet is used.",type:"string"}).options(w).options(g).option(A).option(b("Output the list of updated note types / models as JSON to stdout.")).option(S),async({ankiAutoLaunch:e,ankiConnect:t,ankiWeb:i,css:o,dryRun:a,json:r,verbose:n})=>{const{host:d,port:f}=y(t);let l;if(o!==void 0){if(q.extname(o)!==".css"){c.error("The provided CSS file must have a .css extension."),process.exitCode=1;return}try{l=await W.readFile(o,"utf8")}catch(p){p instanceof Error?c.error(`Error loading CSS file: ${p.message}`):c.error(`Unknown error loading CSS file: ${String(p)}`),process.exitCode=1;return}}const m=await F({ankiConnectOptions:{autoLaunch:e,host:d,port:f},ankiWeb:i,css:l??void 0,dryRun:a}).catch(k);r?(process.stdout.write(JSON.stringify(m,void 0,2)),process.stdout.write(`
+`)):(process.stderr.write(H(m,n)),process.stderr.write(`
+`))}).demandCommand(1).alias("h","help").version(Q).alias("v","version").help().wrap(process.stdout.isTTY?Math.min(120,$.terminalWidth()):0).parse();

package/dist/lib/index.d.ts

@@ -140,10 +140,11 @@ type DeckRequests = Request<'changeDeck', 6, {
 
 type NoteModel = 'Basic (and reversed card)' | 'Basic (type in the answer)' | 'Basic' | 'Cloze' | ({} & string);
 type NoteMedia = {
+    data?: string;
     fields: string[];
-    filename: string;
+    path?: string;
     skipHash?: false;
-    url: string;
+    url?: string;
 };
 type Note = {
     audio?: NoteMedia[];
@@ -266,11 +267,11 @@ type GraphicalRequests = Request<'guiBrowse', 6, {
 type MediaRequests = Request<'retrieveMediaFile', 6, {
     filename: string;
 }, false | string> | Request<'storeMediaFile', 6, {
-    data: string;
-    deleteExisting: boolean;
+    data?: string;
+    deleteExisting?: boolean;
     filename: string;
-    path: string;
-    url: string;
+    path?: string;
+    url?: string;
 }, string> | Request<'deleteMediaFile', 6, {
     filename: string;
 }> | Request<'getMediaDirPath', 6, never, string> | Request<'getMediaFilesNames', 6, {
@@ -527,12 +528,13 @@ type StatisticRequests = Request<'cardReviews', 6, {
  * external re-implementation when passing a custom fetch function to
  * YankiClient.
  */
-type YankiFetch = (input: string, init: {
-    body: string;
-    headers: Record<string, string>;
-    method: string;
-    mode: RequestMode;
+type YankiFetchAdapter = (input: string, init?: {
+    body?: string;
+    headers?: Record<string, string>;
+    method?: string;
+    mode?: RequestMode;
 }) => Promise<{
+    headers: Headers | Record<string, string>;
     json(): Promise<any>;
     status: number;
 } | undefined>;
@@ -567,7 +569,7 @@ type YankiConnectOptions = {
      *
      * @default fetch
      */
-    customFetch: YankiFetch | undefined;
+    fetchAdapter: YankiFetchAdapter | undefined;
     /**
      * Host where the Anki-Connect service is running.
      *
@@ -840,8 +842,21 @@ type YankiNote = Simplify<{
     noteId: number | undefined;
 } & Omit<ParamsForAction<'addNote'>['note'], 'fields' | 'modelName' | 'options'>>;
 
-declare const defaultCleanOptions: CleanOptions;
-type CleanOptions = {
+type FetchAdapter = YankiFetchAdapter;
+type ManageFilenames = 'off' | 'prompt' | 'response';
+type SyncMediaAssets = 'all' | 'local' | 'off' | 'remote';
+type FileAdapter = {
+    readFile(filePath: string): Promise<string>;
+    readFileBuffer(filePath: string): Promise<Uint8Array>;
+    rename(oldPath: string, newPath: string): Promise<void>;
+    stat(filePath: string): Promise<{
+        ctimeMs: number;
+        mtimeMs: number;
+        size: number;
+    }>;
+    writeFile(filePath: string, data: string): Promise<void>;
+};
+type GlobalOptions = {
     ankiConnectOptions: YankiConnectOptions;
     /**
      * Automatically sync any changes to AnkiWeb after Yanki has finished syncing
@@ -850,17 +865,34 @@ type CleanOptions = {
      * button in the Anki app.
      */
     ankiWeb: boolean;
+    cwd: string;
     dryRun: boolean;
+    /**
+     * Exposed for Obsidian, currently only used for getting URL content hashes
+     * and inferring MIME types of URLs without extensions.
+     * Note that ankiConnectOptions ALSO has a fetch adapter option specifically
+     * for communicating with Anki-Connect.
+     */
+    fetchAdapter: FetchAdapter | undefined;
+    fileAdapter: FileAdapter | undefined;
+    manageFilenames: ManageFilenames;
+    /** Only applies if manageFilenames is `true`. Will _not_ truncate user-specified file names in other cases. */
+    maxFilenameLength: number;
     namespace: string;
+    /** Ensures that wiki-style links work correctly */
+    obsidianVault: string | undefined;
+    /** Sync image, video, and audio assets to Anki's media storage system */
+    syncMediaAssets: SyncMediaAssets;
 };
-type CleanReport = {
-    ankiWeb: boolean;
-    decks: string[];
-    deleted: YankiNote[];
-    dryRun: boolean;
+
+type CleanOptions = Pick<GlobalOptions, 'ankiConnectOptions' | 'ankiWeb' | 'dryRun' | 'namespace'>;
+declare const defaultCleanOptions: CleanOptions;
+type CleanResult = Simplify<{
+    deletedDecks: string[];
+    deletedMedia: string[];
+    deletedNotes: YankiNote[];
     duration: number;
-    namespace: string;
-};
+} & Pick<GlobalOptions, 'ankiWeb' | 'dryRun' | 'namespace'>>;
 /**
  * Deletes all remote notes in Anki associated with the given namespace.
  *
@@ -870,15 +902,12 @@ type CleanReport = {
  * @param options
  * @throws
  */
-declare function cleanNotes(options?: PartialDeep<CleanOptions>): Promise<CleanReport>;
-declare function formatCleanReport(report: CleanReport, verbose?: boolean): string;
+declare function cleanNotes(options?: PartialDeep<CleanOptions>): Promise<CleanResult>;
+declare function formatCleanResult(result: CleanResult, verbose?: boolean): string;
 
-type ListOptions = {
-    ankiConnectOptions: YankiConnectOptions;
-    namespace: string;
-};
+type ListOptions = Pick<GlobalOptions, 'ankiConnectOptions' | 'namespace'>;
 declare const defaultListOptions: ListOptions;
-type ListReport = {
+type ListResult = {
     duration: number;
     namespace: string;
     notes: YankiNote[];
@@ -888,107 +917,64 @@ type ListReport = {
  * @param options
  * @returns
  */
-declare function listNotes(options?: PartialDeep<ListOptions>): Promise<ListReport>;
-declare function formatListReport(report: ListReport): string;
-
-type RenameFilesReport = {
-    dryRun: boolean;
-    notes: Array<{
-        filePath: string;
-        filePathOriginal: string;
-        markdown: string;
-        note: YankiNote;
-    }>;
+declare function listNotes(options?: PartialDeep<ListOptions>): Promise<ListResult>;
+declare function formatListResult(result: ListResult): string;
+
+type LoadOptions = Pick<GlobalOptions, 'fetchAdapter' | 'fileAdapter' | 'namespace' | 'obsidianVault' | 'syncMediaAssets'>;
+type LocalNote = {
+    filePath: string;
+    filePathOriginal: string;
+    markdown: string;
+    note: YankiNote;
 };
-type FilenameMode = 'prompt' | 'response';
-type RenameFilesOptions = {
+
+type RenameNotesOptions = Pick<GlobalOptions, 'dryRun' | 'fileAdapter' | 'manageFilenames' | 'maxFilenameLength'>;
+type RenameFilesResult = {
     dryRun: boolean;
-    filenameMode: FilenameMode;
-    manageFilenames: boolean;
-    maxFilenameLength: number;
-    namespace: string;
-    obsidianVault: string | undefined;
+    notes: LocalNote[];
 };
+type RenameFilesOptions = Simplify<LoadOptions & RenameNotesOptions>;
 declare const defaultRenameFilesOptions: RenameFilesOptions;
-/**
- * Also loads the notes from markdown and sets deck names...
- * @param allLocalFilePaths
- * @param options
- * @param readFile
- * @param writeFile
- * @param rename
- */
-declare function renameFiles(allLocalFilePaths: string[], options: Partial<RenameFilesOptions>, readFile?: (filePath: string) => Promise<string>, writeFile?: (filePath: string, data: string) => Promise<void>, // Not used, yet
-rename?: (oldPath: string, newPath: string) => Promise<void>): Promise<RenameFilesReport>;
+declare function renameFiles(allLocalFilePaths: string[], options: Partial<RenameFilesOptions>): Promise<RenameFilesResult>;
 
-type StyleOptions = {
-    ankiConnectOptions: YankiConnectOptions;
-    /**
-     * Automatically sync any changes to AnkiWeb after Yanki has finished syncing
-     * locally. If false, only local Anki data is updated and you must manually
-     * invoke a sync to AnkiWeb. This is the equivalent of pushing the "sync"
-     * button in the Anki app.
-     */
-    ankiWeb: boolean;
+type SetStyleOptions = {
     css: string;
-    dryRun: boolean;
-};
-declare const defaultStyleOptions: StyleOptions;
-type StyleReport = {
-    ankiWeb: boolean;
-    dryRun: boolean;
+} & Pick<GlobalOptions, 'ankiConnectOptions' | 'ankiWeb' | 'dryRun'>;
+declare const defaultSetStyleOptions: SetStyleOptions;
+type SetStyleResult = Simplify<{
     duration: number;
     models: Array<{
         action: 'unchanged' | 'updated';
         name: string;
     }>;
-};
-declare function setStyle(options: PartialDeep<StyleOptions>): Promise<StyleReport>;
-declare function formatStyleReport(report: StyleReport, verbose?: boolean): string;
+} & Pick<GlobalOptions, 'ankiWeb' | 'dryRun'>>;
+type GetStyleOptions = Pick<GlobalOptions, 'ankiConnectOptions'>;
+declare const defaultGetStyleOptions: GetStyleOptions;
+declare function getStyle(options: PartialDeep<GetStyleOptions>): Promise<string>;
+declare function setStyle(options?: PartialDeep<SetStyleOptions>): Promise<SetStyleResult>;
+declare function formatSetStyleResult(result: SetStyleResult, verbose?: boolean): string;
 
 type SyncedNote = {
     action: 'ankiUnreachable' | 'created' | 'deleted' | 'recreated' | 'unchanged' | 'updated';
-    filePath?: string;
-    filePathOriginal?: string;
     note: YankiNote;
 };
-type SyncOptions = {
-    ankiConnectOptions: YankiConnectOptions;
-    /**
-     * Automatically sync any changes to AnkiWeb after Yanki has finished syncing
-     * locally. If false, only local Anki data is updated and you must manually
-     * invoke a sync to AnkiWeb. This is the equivalent of pushing the "sync"
-     * button in the Anki app.
-     */
-    ankiWeb: boolean;
-    defaultDeckName: string;
-    dryRun: boolean;
-    filenameMode: FilenameMode;
-    /** Only applies to syncFiles */
-    manageFilenames: boolean;
-    /** Only applies if manageFilenames is not `false`. Will _not_ truncate user-specified file names in other cases. */
-    maxFilenameLength: number;
-    namespace: string;
-    /** Ensures that wiki-style links work correctly */
-    obsidianVault: string | undefined;
-};
-declare const defaultSyncOptions: SyncOptions;
-type SyncReport = {
-    ankiWeb: boolean;
+type SyncOptions = Pick<GlobalOptions, 'ankiConnectOptions' | 'ankiWeb' | 'dryRun' | 'namespace'>;
+type SyncNotesResult = Simplify<{
     deletedDecks: string[];
-    dryRun: boolean;
+    deletedMedia: string[];
     duration: number;
-    namespace: string;
     synced: SyncedNote[];
-};
-/**
- * Syncs local notes to Anki.
- *
- * @param allLocalNotes All the YankiNotes to sync
- * @returns The synced notes (with new IDs where applicable), plus some stats
- * about the sync @throws
- */
-declare function syncNotes(allLocalNotes: YankiNote[], options?: PartialDeep<SyncOptions>): Promise<SyncReport>;
+} & Pick<GlobalOptions, 'ankiWeb' | 'dryRun' | 'namespace'>>;
+
+type SyncFilesOptions = Simplify<Pick<GlobalOptions, 'fetchAdapter' | 'fileAdapter' | 'manageFilenames' | 'maxFilenameLength' | 'namespace' | 'obsidianVault' | 'syncMediaAssets'> & SyncOptions>;
+declare const defaultSyncFilesOptions: SyncFilesOptions;
+type SyncedFile = Simplify<{
+    filePath: string | undefined;
+    filePathOriginal: string | undefined;
+} & SyncedNote>;
+type SyncFilesResult = Simplify<{
+    synced: SyncedFile[];
+} & Omit<SyncNotesResult, 'synced'>>;
 /**
  * Sync a list of local yanki files to Anki.
  *
@@ -1001,25 +987,19 @@ declare function syncNotes(allLocalNotes: YankiNote[], options?: PartialDeep<Syn
  * @returns The synced files (with new IDs where applicable), plus some stats
  * about the sync @throws
  */
-declare function syncFiles(allLocalFilePaths: string[], options?: PartialDeep<SyncOptions>, readFile?: (filePath: string) => Promise<string>, writeFile?: (filePath: string, data: string) => Promise<void>, rename?: (oldPath: string, newPath: string) => Promise<void>): Promise<SyncReport>;
-declare function formatSyncReport(report: SyncReport, verbose?: boolean): string;
-
-/**
- * Helpers for working with the Markdown AST.
- */
-
-type AstFromMarkdownOptions = {
-    obsidianVault?: string;
-};
+declare function syncFiles(allLocalFilePaths: string[], options?: PartialDeep<SyncFilesOptions>): Promise<SyncFilesResult>;
+declare function formatSyncFilesResult(result: SyncFilesResult, verbose?: boolean): string;
 
 /**
  * Turns a markdown string into a YankiNote object.
  */
 
-type NoteFromMarkdownOptions = {
-    namespace: string;
-} & AstFromMarkdownOptions;
-declare function getNoteFromMarkdown(markdown: string, options: NoteFromMarkdownOptions): Promise<YankiNote>;
+type GetNoteFromMarkdownOptions = {
+    /** Needed for the public API, but optional for more efficient use internally when the namespace is already validated. */
+    namespaceValidationAndSanitization: boolean;
+} & Pick<GlobalOptions, 'cwd' | 'fetchAdapter' | 'fileAdapter' | 'namespace' | 'obsidianVault' | 'syncMediaAssets'>;
+declare const defaultGetNoteFromMarkdownOptions: GetNoteFromMarkdownOptions;
+declare function getNoteFromMarkdown(markdown: string, options?: Partial<GetNoteFromMarkdownOptions>): Promise<YankiNote>;
 
 declare function urlToHostAndPort(url: string): {
     host: string;
@@ -1027,4 +1007,4 @@ declare function urlToHostAndPort(url: string): {
 };
 declare function hostAndPortToUrl(host: string, port: number): string;
 
-export { type CleanOptions, type CleanReport, type ListOptions, type RenameFilesOptions, type RenameFilesReport, type StyleOptions, type StyleReport, type SyncOptions, type SyncReport, type YankiNote, cleanNotes, defaultCleanOptions, defaultListOptions, defaultRenameFilesOptions, defaultStyleOptions, defaultSyncOptions, formatCleanReport, formatListReport, formatStyleReport, formatSyncReport, getNoteFromMarkdown, hostAndPortToUrl, listNotes, renameFiles, setStyle, syncFiles, syncNotes, urlToHostAndPort };
+export { type CleanOptions, type CleanResult, type FetchAdapter, type FileAdapter, type GetNoteFromMarkdownOptions, type GetStyleOptions, type ListOptions, type RenameFilesOptions, type RenameFilesResult, type SetStyleOptions, type SetStyleResult, type SyncFilesOptions, type SyncFilesResult, type YankiNote, cleanNotes, defaultCleanOptions, defaultGetNoteFromMarkdownOptions, defaultGetStyleOptions, defaultListOptions, defaultRenameFilesOptions, defaultSetStyleOptions, defaultSyncFilesOptions, formatCleanResult, formatListResult, formatSetStyleResult, formatSyncFilesResult, getNoteFromMarkdown, getStyle, hostAndPortToUrl, listNotes, renameFiles, setStyle, syncFiles, urlToHostAndPort };

package/dist/lib/index.js

@@ -1 +1 @@
-import{c as l,d as n,a as i,e as p,g as m,i as f,f as d,b as u,h as y,j as c,n as O,o as R,l as S,r as F,s as N,k as g,m as h,u as k}from"../sync-B_u0fKEU.js";import"rehype-mathjax";import"rehype-parse";import"node:path";import"node:crypto";export{l as cleanNotes,n as defaultCleanOptions,i as defaultListOptions,p as defaultRenameFilesOptions,m as defaultStyleOptions,f as defaultSyncOptions,d as formatCleanReport,u as formatListReport,y as formatStyleReport,c as formatSyncReport,O as getNoteFromMarkdown,R as hostAndPortToUrl,S as listNotes,F as renameFiles,N as setStyle,g as syncFiles,h as syncNotes,k as urlToHostAndPort};
+import{c as i,d as n,o as r,g as m,a as f,e as p,h as u,k as d,f as S,b as y,i as F,m as O,p as c,j as R,q as N,l as g,r as k,s as h,n as w,u as A}from"../sync-files-norUev7R.js";import"rehype-mathjax";import"rehype-parse";import"node:path";import"node:crypto";export{i as cleanNotes,n as defaultCleanOptions,r as defaultGetNoteFromMarkdownOptions,m as defaultGetStyleOptions,f as defaultListOptions,p as defaultRenameFilesOptions,u as defaultSetStyleOptions,d as defaultSyncFilesOptions,S as formatCleanResult,y as formatListResult,F as formatSetStyleResult,O as formatSyncFilesResult,c as getNoteFromMarkdown,R as getStyle,N as hostAndPortToUrl,g as listNotes,k as renameFiles,h as setStyle,w as syncFiles,A as urlToHostAndPort};