yanki 2.0.4 → 2.0.5

package/dist/standalone/index.d.ts

@@ -1,4 +1,4 @@
-//#region node_modules/.pnpm/type-fest@5.5.0/node_modules/type-fest/source/primitive.d.ts
+//#region node_modules/.pnpm/type-fest@5.6.0/node_modules/type-fest/source/primitive.d.ts
 /**
 Matches any [primitive value](https://developer.mozilla.org/en-US/docs/Glossary/Primitive).
 
@@ -6,7 +6,7 @@ Matches any [primitive value](https://developer.mozilla.org/en-US/docs/Glossary/
 */
 type Primitive = null | undefined | string | number | boolean | symbol | bigint;
 //#endregion
-//#region node_modules/.pnpm/type-fest@5.5.0/node_modules/type-fest/source/is-any.d.ts
+//#region node_modules/.pnpm/type-fest@5.6.0/node_modules/type-fest/source/is-any.d.ts
 /**
 Returns a boolean for whether the given type is `any`.
 
@@ -37,7 +37,7 @@ const anyA = get(anyObject, 'a');
 */
 type IsAny<T> = 0 extends 1 & NoInfer<T> ? true : false;
 //#endregion
-//#region node_modules/.pnpm/type-fest@5.5.0/node_modules/type-fest/source/is-optional-key-of.d.ts
+//#region node_modules/.pnpm/type-fest@5.6.0/node_modules/type-fest/source/is-optional-key-of.d.ts
 /**
 Returns a boolean for whether the given key is an optional key of type.
 
@@ -80,7 +80,7 @@ type T5 = IsOptionalKeyOf<User | Admin, 'surname'>;
 */
 type IsOptionalKeyOf<Type extends object, Key extends keyof Type> = IsAny<Type | Key> extends true ? never : Key extends keyof Type ? Type extends Record<Key, Type[Key]> ? false : true : false;
 //#endregion
-//#region node_modules/.pnpm/type-fest@5.5.0/node_modules/type-fest/source/optional-keys-of.d.ts
+//#region node_modules/.pnpm/type-fest@5.6.0/node_modules/type-fest/source/optional-keys-of.d.ts
 /**
 Extract all optional keys from the given type.
 
@@ -118,7 +118,7 @@ type OptionalKeysOf<Type extends object> = Type extends unknown // For distribut
 ? (keyof { [Key in keyof Type as IsOptionalKeyOf<Type, Key> extends false ? never : Key]: never }) & keyof Type // Intersect with `keyof Type` to ensure result of `OptionalKeysOf<Type>` is always assignable to `keyof Type`
 : never;
 //#endregion
-//#region node_modules/.pnpm/type-fest@5.5.0/node_modules/type-fest/source/required-keys-of.d.ts
+//#region node_modules/.pnpm/type-fest@5.6.0/node_modules/type-fest/source/required-keys-of.d.ts
 /**
 Extract all required keys from the given type.
 
@@ -152,7 +152,7 @@ const validator3 = createValidation<User>('luckyNumber', value => value > 0);
 type RequiredKeysOf<Type extends object> = Type extends unknown // For distributing `Type`
 ? Exclude<keyof Type, OptionalKeysOf<Type>> : never;
 //#endregion
-//#region node_modules/.pnpm/type-fest@5.5.0/node_modules/type-fest/source/is-never.d.ts
+//#region node_modules/.pnpm/type-fest@5.6.0/node_modules/type-fest/source/is-never.d.ts
 /**
 Returns a boolean for whether the given type is `never`.
 
@@ -208,7 +208,7 @@ type B = IsTrueFixed<never>;
 */
 type IsNever<T> = [T] extends [never] ? true : false;
 //#endregion
-//#region node_modules/.pnpm/type-fest@5.5.0/node_modules/type-fest/source/if.d.ts
+//#region node_modules/.pnpm/type-fest@5.6.0/node_modules/type-fest/source/if.d.ts
 /**
 An if-else-like type that resolves depending on whether the given `boolean` type is `true` or `false`.
 
@@ -303,7 +303,7 @@ type Works = IncludesWithoutIf<HundredZeroes, '1'>;
 */
 type If<Type extends boolean, IfBranch, ElseBranch> = IsNever<Type> extends true ? ElseBranch : Type extends true ? IfBranch : ElseBranch;
 //#endregion
-//#region node_modules/.pnpm/type-fest@5.5.0/node_modules/type-fest/source/internal/type.d.ts
+//#region node_modules/.pnpm/type-fest@5.6.0/node_modules/type-fest/source/internal/type.d.ts
 /**
 Matches any primitive, `void`, `Date`, or `RegExp` value.
 */
@@ -321,7 +321,7 @@ type HasMultipleCallSignatures<T extends (...arguments_: any[]) => unknown> = T
   (...arguments_: infer B): unknown;
 } ? B extends A ? A extends B ? false : true : true : false;
 //#endregion
-//#region node_modules/.pnpm/type-fest@5.5.0/node_modules/type-fest/source/simplify.d.ts
+//#region node_modules/.pnpm/type-fest@5.6.0/node_modules/type-fest/source/simplify.d.ts
 /**
 Useful to flatten the type output to improve type hints shown in editors. And also to transform an interface into a type to aide with assignability.
 
@@ -382,7 +382,7 @@ fn(someInterface as Simplify<SomeInterface>); // Good: transform an `interface`
 */
 type Simplify<T> = { [KeyType in keyof T]: T[KeyType] } & {};
 //#endregion
-//#region node_modules/.pnpm/type-fest@5.5.0/node_modules/type-fest/source/is-equal.d.ts
+//#region node_modules/.pnpm/type-fest@5.6.0/node_modules/type-fest/source/is-equal.d.ts
 /**
 Returns a boolean for whether the two given types are equal.
 
@@ -413,7 +413,7 @@ type IsEqual<A, B> = [A] extends [B] ? [B] extends [A] ? _IsEqual<A, B> : false
 // This version fails the `equalWrappedTupleIntersectionToBeNeverAndNeverExpanded` test in `test-d/is-equal.ts`.
 type _IsEqual<A, B> = (<G>() => G extends A & G | G ? 1 : 2) extends (<G>() => G extends B & G | G ? 1 : 2) ? true : false;
 //#endregion
-//#region node_modules/.pnpm/type-fest@5.5.0/node_modules/type-fest/source/omit-index-signature.d.ts
+//#region node_modules/.pnpm/type-fest@5.6.0/node_modules/type-fest/source/omit-index-signature.d.ts
 /**
 Omit any index signatures from the given object type, leaving only explicitly defined properties.
 
@@ -507,7 +507,7 @@ type ExampleWithoutIndexSignatures = OmitIndexSignature<Example>;
 */
 type OmitIndexSignature<ObjectType> = { [KeyType in keyof ObjectType as {} extends Record<KeyType, unknown> ? never : KeyType]: ObjectType[KeyType] };
 //#endregion
-//#region node_modules/.pnpm/type-fest@5.5.0/node_modules/type-fest/source/pick-index-signature.d.ts
+//#region node_modules/.pnpm/type-fest@5.6.0/node_modules/type-fest/source/pick-index-signature.d.ts
 /**
 Pick only index signatures from the given object type, leaving out all explicitly defined properties.
 
@@ -555,7 +555,7 @@ type ExampleIndexSignature = PickIndexSignature<Example>;
 */
 type PickIndexSignature<ObjectType> = { [KeyType in keyof ObjectType as {} extends Record<KeyType, unknown> ? KeyType : never]: ObjectType[KeyType] };
 //#endregion
-//#region node_modules/.pnpm/type-fest@5.5.0/node_modules/type-fest/source/merge.d.ts
+//#region node_modules/.pnpm/type-fest@5.6.0/node_modules/type-fest/source/merge.d.ts
 // Merges two objects without worrying about index signatures.
 type SimpleMerge<Destination, Source> = Simplify<{ [Key in keyof Destination as Key extends keyof Source ? never : Key]: Destination[Key] } & Source>;
 /**
@@ -627,7 +627,7 @@ type Merge<Destination, Source> = Destination extends unknown // For distributin
 // Should never happen
 type _Merge<Destination, Source> = Simplify<SimpleMerge<PickIndexSignature<Destination>, PickIndexSignature<Source>> & SimpleMerge<OmitIndexSignature<Destination>, OmitIndexSignature<Source>>>;
 //#endregion
-//#region node_modules/.pnpm/type-fest@5.5.0/node_modules/type-fest/source/internal/object.d.ts
+//#region node_modules/.pnpm/type-fest@5.6.0/node_modules/type-fest/source/internal/object.d.ts
 /**
 Merges user specified options with default options.
 
@@ -682,7 +682,7 @@ type Result = ApplyDefaultOptions<PathsOptions, DefaultPathsOptions, SpecifiedOp
 */
 type ApplyDefaultOptions<Options extends object, Defaults extends Simplify<Omit<Required<Options>, RequiredKeysOf<Options>> & Partial<Record<RequiredKeysOf<Options>, never>>>, SpecifiedOptions extends Options> = If<IsAny<SpecifiedOptions>, Defaults, If<IsNever<SpecifiedOptions>, Defaults, Simplify<Merge<Defaults, { [Key in keyof SpecifiedOptions as Key extends OptionalKeysOf<Options> ? undefined extends SpecifiedOptions[Key] ? never : Key : Key]: SpecifiedOptions[Key] }> & Required<Options>>>>;
 //#endregion
-//#region node_modules/.pnpm/type-fest@5.5.0/node_modules/type-fest/source/partial-deep.d.ts
+//#region node_modules/.pnpm/type-fest@5.6.0/node_modules/type-fest/source/partial-deep.d.ts
 /**
 @see {@link PartialDeep}
 */
@@ -715,12 +715,14 @@ type DefaultPartialDeepOptions = {
   allowUndefinedInNonTupleArrays: false;
 };
 /**
-Create a type from another type with all keys and nested keys set to optional.
+Create a deeply optional version of another type.
 
 Use-cases:
 - Merging a default settings/config object with another object, the second object would be a deep partial of the default object.
 - Mocking and testing complex entities, where populating an entire object with its keys would be redundant in terms of the mock or test.
 
+Use [`Partial<T>`](https://www.typescriptlang.org/docs/handbook/utility-types.html#partialtype) if you only need one level deep.
+
 @example
 ```
 import type {PartialDeep} from 'type-fest';
@@ -794,7 +796,7 @@ Same as `PartialDeep`, but accepts only `object`s as inputs. Internal helper for
 */
 type PartialObjectDeep<ObjectType extends object, Options extends Required<PartialDeepOptions>> = { [KeyType in keyof ObjectType]?: _PartialDeep<ObjectType[KeyType], Options> };
 //#endregion
-//#region node_modules/.pnpm/yanki-connect@4.0.2/node_modules/yanki-connect/dist/index.d.ts
+//#region node_modules/.pnpm/yanki-connect@4.0.3/node_modules/yanki-connect/dist/index.d.ts
 //#region src/types/deck.d.ts
 type DeckStats = {
   deck_id: number;
@@ -1338,11 +1340,11 @@ type YankiConnectOptions = {
    * Attempt to open the desktop Anki.app if it's not already running.
    *
    * - `true` will always attempt to open Anki _when a request is made_. This
-   * might introduce significant latency on the first launch.
-   * - `false` will never attempt to open Anki. Requests will fail until
-   * something or someone else opens the Anki app.
-   * -  `immediately` is a special option that will open Anki when the client is
-   * instantiated.
+   *   might introduce significant latency on the first launch.
+   * - `false` will never attempt to open Anki. Requests will fail until something
+   *   or someone else opens the Anki app.
+   * - `immediately` is a special option that will open Anki when the client is
+   *   instantiated.
    *
    * The Anki desktop app must be running for the client and the underlying
    * Anki-Connect service to work.
@@ -1350,30 +1352,37 @@ type YankiConnectOptions = {
    * Currently supported on macOS only.
    *
    * The client does not attempt to close the app.
+   *
    * @default false
    */
   autoLaunch: 'immediately' | boolean;
   /**
-   * Advanced option to customize the resource fetch implementation used to make requests to Anki-Connect.
+   * Advanced option to customize the resource fetch implementation used to make
+   * requests to Anki-Connect.
    *
-   * Note that the signature reflects the subset of the built-in Fetch interface that's actually used by yanki-connect.
+   * Note that the signature reflects the subset of the built-in Fetch interface
+   * that's actually used by yanki-connect.
    *
    * The exact signature of this option is subject to change in the future.
+   *
    * @default fetch
    */
   fetchAdapter: undefined | YankiFetchAdapter;
   /**
    * Host where the Anki-Connect service is running.
+   *
    * @default 'http://127.0.0.1'
    */
   host: string;
   /**
    * Anki-Connect security key (optional)
+   *
    * @default undefined
    */
   key: string | undefined;
   /**
    * Port where the Anki-Connect service is running.
+   *
    * @default 8765
    */
   port: number;
@@ -1381,6 +1390,7 @@ type YankiConnectOptions = {
    * Anki-Connect API version.
    *
    * Only API version 6 is supported for now.
+   *
    * @default 6
    */
   version: AnkiConnectVersion;
@@ -1467,20 +1477,32 @@ type GlobalOptions = {
    * invoke a sync to AnkiWeb. This is the equivalent of pushing the "sync"
    * button in the Anki app.
    */
-  ankiWeb: boolean; /** Override where "/" should resolve to... useful in Obsidian to set the vault path as the "root" */
-  basePath: string | undefined; /** Run Anki's "Check Database" command after sync updates that might produce card corruption */
+  ankiWeb: boolean;
+  /**
+   * Override where "/" should resolve to... useful in Obsidian to set the vault
+   * path as the "root"
+   */
+  basePath: string | undefined;
+  /**
+   * Run Anki's "Check Database" command after sync updates that might produce
+   * card corruption
+   */
   checkDatabase: 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.
+   * 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. */
+  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; /** Exposed for testing only */
@@ -1489,7 +1511,12 @@ type GlobalOptions = {
    * Whether to treat single newlines in Markdown as line breaks in the
    * resulting HTML (Obsidian has an application-level setting for this)
    */
-  strictLineBreaks: boolean; /** Only consider exact noteId matches between the local and remote copies to be equivalent, don't match local notes with "orphaned" remote notes based on content */
+  strictLineBreaks: boolean;
+  /**
+   * Only consider exact noteId matches between the local and remote copies to
+   * be equivalent, don't match local notes with "orphaned" remote notes based
+   * on content
+   */
   strictMatching: boolean; /** Sync image, video, and audio assets to Anki's media storage system */
   syncMediaAssets: SyncMediaAssets;
 };
@@ -1507,8 +1534,10 @@ type CleanResult = Simplify<Pick<GlobalOptions, 'ankiWeb' | 'dryRun' | 'namespac
  * Deletes all remote notes in Anki associated with the given namespace.
  *
  * Use with significant caution. Mostly useful for testing.
+ *
  * @returns The IDs of the notes that were deleted
- * @throws {Error} If Anki is unreachable or another error occurs during deletion.
+ * @throws {Error} If Anki is unreachable or another error occurs during
+ *   deletion.
  */
 declare function cleanNotes(options?: PartialDeep<CleanOptions>): Promise<CleanResult>;
 declare function formatCleanResult(result: CleanResult, verbose?: boolean): string;
@@ -1537,7 +1566,12 @@ type LocalNote = {
 };
 //#endregion
 //#region src/lib/actions/rename.d.ts
-type RenameNotesOptions = Pick<GlobalOptions, 'dryRun' | 'fileAdapter' | 'manageFilenames' | 'maxFilenameLength' /** Included because this can technically change the content of the "first line" of a card */ | 'strictLineBreaks'>;
+type RenameNotesOptions = Pick<GlobalOptions, 'dryRun' | 'fileAdapter' | 'manageFilenames' | 'maxFilenameLength'
+/**
+ * Included because this can technically change the content of the "first
+ * line" of a card
+ */
+| 'strictLineBreaks'>;
 type RenameFilesResult = {
   dryRun: boolean;
   notes: LocalNote[];
@@ -1584,9 +1618,11 @@ type SyncNotesResult = Simplify<Pick<GlobalOptions, 'ankiWeb' | 'dryRun' | 'name
 }>;
 /**
  * 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
+ *   about the sync
  * @throws {Error} For various reasons...
  */
 declare function syncNotes(allLocalNotes: YankiNote[], options?: PartialDeep<SyncNotesOptions>): Promise<SyncNotesResult>;
@@ -1608,9 +1644,11 @@ type SyncFilesResult = Simplify<Omit<SyncNotesResult, 'synced'> & {
  *
  * Most importantly, it updates the note IDs in the frontmatter of the local
  * files.
+ *
  * @param allLocalFilePaths Array of paths to the local markdown files
+ *
  * @returns The synced files (with new IDs where applicable), plus some stats
- * about the sync
+ *   about the sync
  * @throws {Error} If syncing fails or file operations encounter an error.
  */
 declare function syncFiles(allLocalFilePaths: string[], options?: PartialDeep<SyncFilesOptions>): Promise<SyncFilesResult>;