@hesprs/sync-engine-sdk 3.1.3 → 3.1.5

package/dist/dev.js

@@ -1 +1 @@
-import e from"./debug-wrapper.js";import t from"./plugin/test/test-kit.js";import n from"./plugin/src/utils/sha-256.js";import r from"./transform.js";export{e as debugWrapper,n as sha256,r as syncEngineModule,t as testKit};
+import e from"./debug-wrapper.js";import t from"./plugin/test/test-kit.js";import n from"./plugin/src/utils/sha-256.js";export{e as debugWrapper,n as sha256,t as testKit};

package/dist/dev.spec.d.ts

@@ -80,25 +80,4 @@ declare const testKit: {
 //#region src/utils/sha-256.d.ts
 declare function sha256(input: string): Promise<string>;
 //#endregion
-//#region src/sdk/transform.d.ts
-type SyncEngineConfig = {
-  deps?: {
-    neverBundle?: true | string | RegExp | Array<string | RegExp> | ((id: string, parentId: string | undefined, isResolved: boolean) => boolean | null | undefined);
-  };
-};
-type ModuleMeta = Partial<Record<'name' | 'icon' | 'description' | 'source' | 'version' | 'readme', string>>;
-type ModuleMetaWithId = ModuleMeta & {
-  id: string;
-};
-declare function syncEngineModule(meta?: ModuleMeta | Array<ModuleMetaWithId> | Record<string, ModuleMeta>): {
-  name: string;
-  renderChunk(code: string, chunk: {
-    name: string;
-    isEntry: boolean;
-  }): {
-    code: string;
-  } | undefined;
-  tsdownConfig(config: SyncEngineConfig): void;
-};
-//#endregion
-export { debugWrapper, sha256, syncEngineModule, testKit };
+export { debugWrapper, sha256, testKit };

package/dist/index.js

@@ -1 +1 @@
-import{pipe as e,readWithSize as t,writeWithValue as n}from"./plugin/src/utils/pipe.js";import r from"./plugin/src/components/MigrationModal.js";import i from"./prefix.js";import{generateEditableList as a,reactivelyValidate as o,s}from"./plugin/src/settings/utils.js";function c(e){let t=e;for(;`original`in t;)t=t.original;return t}export{c as digOriginal,a as generateEditableList,e as pipe,i as prefixWrapper,o as reactivelyValidate,t as readWithSize,s,r as setNeedMigration,n as writeWithValue};
+import{chunkSize as e,concurrency as t,pipe as n,readWithSize as r,writeWithValue as i}from"./plugin/src/utils/pipe.js";import a from"./plugin/src/components/MigrationModal.js";import o from"./prefix.js";import{generateEditableList as s,reactivelyValidate as c,s as l}from"./plugin/src/settings/utils.js";function u(e){let t=e;for(;`original`in t;)t=t.original;return t}export{e as chunkSize,t as concurrency,u as digOriginal,s as generateEditableList,n as pipe,o as prefixWrapper,c as reactivelyValidate,r as readWithSize,l as s,a as setNeedMigration,i as writeWithValue};

package/dist/index.spec.d.ts

@@ -74,12 +74,13 @@ declare class EventBus {
 //#endregion
 //#region src/modules/I18n.d.ts
 type ObsidianLanguageCode = 'en' | 'af' | 'am' | 'ar' | 'az' | 'be' | 'bg' | 'bn' | 'ca' | 'cs' | 'da' | 'de' | 'dv' | 'el' | 'en-GB' | 'eo' | 'es' | 'eu' | 'fa' | 'fi' | 'fr' | 'ga' | 'gl' | 'he' | 'hi' | 'hr' | 'hu' | 'id' | 'it' | 'ja' | 'ka' | 'kh' | 'kn' | 'ko' | 'ky' | 'la' | 'lt' | 'lv' | 'ml' | 'ms' | 'nan-TW' | 'ne' | 'nl' | 'nn' | 'no' | 'oc' | 'or' | 'pl' | 'pt' | 'pt-BR' | 'ro' | 'ru' | 'sa' | 'si' | 'sk' | 'sl' | 'sq' | 'sr' | 'sv' | 'sw' | 'ta' | 'te' | 'th' | 'tl' | 'tr' | 'tt' | 'uk' | 'ur' | 'uz' | 'vi' | 'zh' | 'zh-TW';
-type Primitive = string | number | boolean | null | undefined;
-type Fragment<A = undefined> = (frag: DocumentFragment, args: A) => void;
-type TranslationResource = Record<string, string | Fragment<General$1>>;
-type InterpolationValues = Record<string, Primitive>;
-type TranslateParams<R extends Fragment<General$1> | string> = R extends Fragment<infer A> ? ([undefined] extends [A] ? [] : [A]) : [] | [InterpolationValues];
-type Translate<O extends TranslationResource> = <K extends keyof O>(key: K, ...args: TranslateParams<O[K]>) => O[K] extends string ? string : DocumentFragment;
+type Factory<A = undefined> = (args: A) => DocumentFragment | string;
+type Fragment<A = undefined> = (args: A) => DocumentFragment;
+type Snippet<A = undefined> = (args: A) => string;
+type TranslationTypes = string | Factory<General$1>;
+type TranslationResource = Record<string, TranslationTypes>;
+type TranslateParams<R extends TranslationTypes> = R extends Factory<infer A> ? ([A] extends [undefined] ? [] : [A]) : [];
+type Translate<O extends TranslationResource> = <K extends keyof O>(key: K, ...arg: TranslateParams<O[K]>) => O[K] extends string | Snippet<General$1> ? string : DocumentFragment;
 declare class I18n {
   private readonly targetLangs;
   readonly i18n: {};
@@ -87,7 +88,7 @@ declare class I18n {
   private readonly translate;
   root: {
     registerI18n: (code: ObsidianLanguageCode, resource: TranslationResource) => void;
-    translate: Translate<General$1>;
+    translate: Translate<TranslationResource>;
   };
 }
 //#endregion
@@ -113,8 +114,6 @@ type FailedTaskInfo = TaskInfo & {
 };
 declare class Sync {
   private readonly ctx;
-  dispatch: Dispatch<Events>;
-  on: On<Events>;
   constructor(ctx: {
     dispatch: Dispatch<Events>;
     initializeSync: () => Infras;
@@ -151,16 +150,7 @@ declare class Sync {
   private readonly executeSync;
   private readonly convertDeleteToUpload;
   root: {
-    executeSync: (trigger: string) => Promise<{
-      result: "cancelled";
-    } | {
-      result: "completed";
-    } | {
-      result: "failed";
-      error: string;
-    } | {
-      result: "noop";
-    }>;
+    executeSync: (trigger: string) => Promise<SyncTerminateReason>;
   };
 }
 //#endregion
@@ -170,6 +160,7 @@ type AddRibbonIcon = (icon: IconName, title: string, callback: (evt: MouseEvent)
 declare class Observability {
   private readonly ctx;
   private lastSyncTime;
+  private lastFailure?;
   private readonly sinceLastSyncText;
   private readonly syncStage;
   private readonly walkProgress;
@@ -219,7 +210,7 @@ declare class Observability {
 //#region src/components/file-tree/index.d.ts
 type FileTreeTranslations = {
   selectAll: string;
-  xSelected: string;
+  xSelected: Snippet<number>;
 };
 //#endregion
 //#region src/modules/Extensibility.d.ts
@@ -259,9 +250,9 @@ declare class Extensibility {
     modules: Record<string, object>;
   };
   readonly i18n: {
-    failedToLoadModule: string;
-    failedToDownloadModule: string;
-    failedToFetchSource: string;
+    failedToLoadModule: Snippet<string>;
+    failedToDownloadModule: Snippet<string>;
+    failedToFetchSource: Snippet<string>;
   };
   readonly events: {
     moduleLoaded: string;
@@ -404,15 +395,15 @@ type LabelDefinition = {
   color?: string;
   textColor?: string;
 };
-declare function s(parent: (self: SettingTree) => AugmentedSettingDefinitionItem, children?: CallableOrObjectTree): CallableOrObjectTree;
-declare function reactivelyValidate<T>({ text, parse, onSave, format, immediate }: {
+export declare function s(parent: (self: SettingTree) => AugmentedSettingDefinitionItem, children?: CallableOrObjectTree): CallableOrObjectTree;
+export declare function reactivelyValidate<T>({ text, parse, onSave, format, immediate }: {
   text: TextComponent;
   parse: (value: string) => T | undefined;
   format?: (value: T) => string;
   onSave: (value: T) => void;
   immediate?: boolean;
 }): void;
-declare function generateEditableList<T>({ memoryDB, items, identifier, saveSettings, rerenderSettingTab, defaultValue, render, translations: { add, empty, heading }, extraButtons }: {
+export declare function generateEditableList<T>({ memoryDB, items, identifier, saveSettings, rerenderSettingTab, defaultValue, render, translations: { add, empty, heading }, extraButtons }: {
   memoryDB: DatabaseSync<EphemeralEditableListSchema>;
   items: Array<T>;
   identifier: string;
@@ -459,7 +450,7 @@ type DevelopmentSettingTranslations = {
   moduleSources: string;
   moduleSourcesDescription: string;
   edit: string;
-  xConfigured: string;
+  xConfigured: Snippet<number>;
   addSource: string;
   noSourceConfigured: string;
   moduleSourcePlaceholder: string;
@@ -517,7 +508,7 @@ type FeaturesSettingTranslations = {
   scheduledSyncPlaceholder: string;
   asymmetricStorage: string;
   asymmetricStorageDescription: Fragment;
-  asymmetricStorageMigration: Fragment<'enable' | 'disable'>;
+  asymmetricStorageMigration: Fragment<boolean>;
 } & MigrationModalTranslations;
 //#endregion
 //#region src/settings/filter.d.ts
@@ -527,7 +518,7 @@ type FilterSettingTranslations = {
   inclusionRulesDescription: Fragment;
   exclusionRules: string;
   exclusionRulesDescription: Fragment;
-  xConfigured: string;
+  xConfigured: Snippet<number>;
   addInclusionRule: string;
   addExclusionRule: string;
   noRuleConfigured: string;
@@ -550,7 +541,7 @@ type HeadSettingTranslations = {
   checkConnection: string;
   conflictResolveStrategy: string;
   conflictResolveStrategyDescription: string;
-  xEnabled: string;
+  xEnabled: Snippet<number>;
   settingTips: Fragment<{
     labels: Array<LabelDefinition>;
     addLabel: typeof addLabel;
@@ -574,12 +565,14 @@ type MiscellaneousSettingTranslations = {
   customHeaders: string;
   customHeadersDescription: string;
   edit: string;
-  xConfigured: string;
+  xConfigured: Snippet<number>;
   addHeader: string;
   noHeaderConfigured: string;
   headerKeyPlaceholder: string;
   headerValuePlaceholder: string;
   addSecretHeader: string;
+  avoidAutoSyncWhenOffline: string;
+  avoidAutoSyncWhenOfflineDescription: string;
 };
 //#endregion
 //#region src/components/module-management/index.d.ts
@@ -739,9 +732,9 @@ declare class ProgressModal extends Modal {
   readonly i18n: {
     syncProgress: string;
     completed: string;
-    failedTasksDescription: string;
-    confirmDeleteDescription: string;
-    confirmTasksDescription: Fragment<TaskCounts>;
+    failedTasksDescription: Snippet<number>;
+    confirmDeleteDescription: Snippet<number>;
+    confirmTasksDescription: Snippet<TaskCounts>;
     hide: string;
     confirm: string;
     cancel: string;
@@ -779,6 +772,7 @@ declare class Scheduler {
     registerEvent: (ref: EventRef) => void;
     app: App;
     isIdle: Ref<boolean>;
+    dispatch: Dispatch<Events>;
   });
   settings: {
     startupSync: TogglableValue;
@@ -786,6 +780,7 @@ declare class Scheduler {
     realtimeSync: TogglableValue;
     exclusionRules: Array<GlobMatchRule>;
     inclusionRules: Array<GlobMatchRule>;
+    avoidAutoSyncWhenOffline: boolean;
   };
   private readonly requestSync;
   start: () => void;
@@ -822,17 +817,18 @@ type Translations = MergeSingleKey<InternalModules, 'i18n'>;
 declare function prefixWrapper(original: Fs, prefix: string): WrappedFs;
 //#endregion
 //#region src/utils/pipe.d.ts
-declare function pipe({ from, to, stat, key }: {
+declare const chunkSize: number, concurrency: number;
+export declare function pipe({ from, to, stat, key }: {
   from: Fs;
   to: Fs;
   key: string;
   stat: FileStat;
 }): Promise<string | undefined>;
-declare function readWithSize(fs: Fs, key: string, stat: FileStat): Promise<Binary | ReadableStream<Binary> | undefined>;
-declare function writeWithValue(fs: Fs, key: string, value: Binary | ReadableStream<Binary>, stat: FileStat): MaybePromise<string>;
+export declare function readWithSize(fs: Fs, key: string, stat: FileStat): Promise<Binary | ReadableStream<Binary> | undefined>;
+export declare function writeWithValue(fs: Fs, key: string, value: Binary | ReadableStream<Binary>, stat: FileStat): MaybePromise<string>;
 //#endregion
 //#region src/sdk/index.d.ts
-declare function digOriginal(wrapped: Fs): RootFs;
-type SelectFromContext<O extends object> = Context extends O ? O : never;
+export declare function digOriginal(wrapped: Fs): RootFs;
+export type SelectFromContext<O extends object> = Context extends O ? O : never;
 //#endregion
-export { type AddRecord, type AugmentedModuleMeta, type BaseTask, type BatchOptimizer, type Binary, type CallableOrObjectTree, type CheckConnectionResult, type ConflictResolver, type ConflictResolverEntry, type ConflictResolverPayload, type Context, type CreateLocalDir, type CreateRemoteDir, type CustomAtom, type DatabaseAsync, type DatabaseSync, type Decider, type DeciderEntry, type DeciderInput, type DeleteAtom, type Dispatch, type Download, type Events, type ExistingMemoryDB, type FileStat, type FolderStat, type Fragment, type Fs, type FsWrapperEntry, type InputAtom, type LabelDefinition, type ListReporter, type LocalRequestMiddlewareEntry, type MaybePromise, type MkdirAtom, type ModuleMeta, type MoveAtom, type MoveLocal, type MoveRemote, type ObsidianLanguageCode, type On, type OptimizerEntry, type OptimizerInput, type OptimizerOutput, type OutputAtom, type Progress, type RecordStat, type RecordStatsMap, type RecordStore, type RemoteFsEntry, type RemoteLister, type RemoteListerEntry, type RemoteRequestMiddlewareEntry, type RemoveLocal, type RemoveRecord, type RemoveRemote, type Request, type RequestParam, type RequestResponse, type ResolveConflict, type RootFs, SelectFromContext, type SettingEntry, type Settings, type Stat, type StatsMap, type StoreAsync, type StoreOperations, type StoreSync, type SyncTerminateReason, type TaskFactory, type TaskNames, type Translate, type TranslationResource, type Translations, type Upload, type VaultRequest, type WrappedFs, type WriteAtom, digOriginal, generateEditableList, pipe, prefixWrapper, reactivelyValidate, readWithSize, s, setNeedMigration, writeWithValue };
+export { type AddRecord, type AugmentedModuleMeta, type BaseTask, type BatchOptimizer, type Binary, type CallableOrObjectTree, type CheckConnectionResult, type ConflictResolver, type ConflictResolverEntry, type ConflictResolverPayload, type Context, type CreateLocalDir, type CreateRemoteDir, type CustomAtom, type DatabaseAsync, type DatabaseSync, type Decider, type DeciderEntry, type DeciderInput, type DeleteAtom, type Dispatch, type Download, type Events, type ExistingMemoryDB, type FileStat, type FolderStat, type Fragment, type Fs, type FsWrapperEntry, type InputAtom, type LabelDefinition, type ListReporter, type LocalRequestMiddlewareEntry, type MaybePromise, type MkdirAtom, type ModuleMeta, type MoveAtom, type MoveLocal, type MoveRemote, type ObsidianLanguageCode, type On, type OptimizerEntry, type OptimizerInput, type OptimizerOutput, type OutputAtom, type Progress, type RecordStat, type RecordStatsMap, type RecordStore, type RemoteFsEntry, type RemoteLister, type RemoteListerEntry, type RemoteRequestMiddlewareEntry, type RemoveLocal, type RemoveRecord, type RemoveRemote, type Request, type RequestParam, type RequestResponse, type ResolveConflict, type RootFs, type SettingEntry, type Settings, type Snippet, type Stat, type StatsMap, type StoreAsync, type StoreOperations, type StoreSync, type SyncTerminateReason, type TaskFactory, type TaskNames, type Translate, type TranslationResource, type Translations, type Upload, type VaultRequest, type WrappedFs, type WriteAtom, chunkSize, concurrency, prefixWrapper, setNeedMigration };

package/dist/pipe-wkp7flXx.js

@@ -0,0 +1 @@
+import{Platform as e}from"obsidian";function t(e){let t=e,n=[t.status,t.res?.status,t.response?.status];for(let e of n)if(typeof e==`number`)return e}function n(){let t=5*1024**2;`deviceMemory`in navigator&&typeof navigator.deviceMemory==`number`?navigator.deviceMemory<=4&&(t/=2):navigator.hardwareConcurrency<=4&&(t/=2),e.isAndroidApp&&(t/=2);let n=t*.8;return{chunkSize:n,concurrency:Math.floor(16777216/n),streamThreshold:t}}const{chunkSize:r,concurrency:i,streamThreshold:a}=n();async function o({from:e,to:t,stat:n,key:r}){let i=await s(e,r,n);if(i)return c(t,r,i,n)}async function s(e,t,n){try{return n.size>a?await e.readStream(t,n):await e.read(t,n)}catch(e){if(l(e))return;throw e}}function c(e,t,n,r){return n instanceof ReadableStream?e.writeStream(t,n,r):e.write(t,n,r)}function l(e){return t(e)===404||(e.message??String(e)).toLocaleUpperCase().includes(`ENOENT`)}export{c as a,s as i,i as n,o as r,r as t};

package/dist/plugin/src/fs/wrappers/memory-control.js

@@ -0,0 +1 @@
+const e=16777216;export{e as STREAM_RESERVATION_SIZE};

package/dist/plugin/src/utils/pipe.js

@@ -1 +1 @@
-import{getStatus as e}from"../../../shared/src/get-status.js";const t=2.5*1024**2;async function n({from:e,to:t,stat:n,key:a}){let o=await r(e,a,n);if(o)return i(t,a,o,n)}async function r(e,n,r){try{return r.size>t?await e.readStream(n,r):await e.read(n,r)}catch(e){if(a(e))return;throw e}}function i(e,t,n,r){return n instanceof ReadableStream?e.writeStream(t,n,r):e.write(t,n,r)}function a(t){return e(t)===404||(t.message??String(t)).toLocaleUpperCase().includes(`ENOENT`)}export{n as pipe,r as readWithSize,i as writeWithValue};
+import{getStatus as e}from"../../../shared/src/get-status.js";import{STREAM_RESERVATION_SIZE as t}from"../fs/wrappers/memory-control.js";import{Platform as n}from"obsidian";function r(){let e=5*1024**2;`deviceMemory`in navigator&&typeof navigator.deviceMemory==`number`?navigator.deviceMemory<=4&&(e/=2):navigator.hardwareConcurrency<=4&&(e/=2),n.isAndroidApp&&(e/=2);let r=e*.8;return{chunkSize:r,concurrency:Math.floor(t/r),streamThreshold:e}}const{chunkSize:i,concurrency:a,streamThreshold:o}=r();async function s({from:e,to:t,stat:n,key:r}){let i=await c(e,r,n);if(i)return l(t,r,i,n)}async function c(e,t,n){try{return n.size>o?await e.readStream(t,n):await e.read(t,n)}catch(e){if(u(e))return;throw e}}function l(e,t,n,r){return n instanceof ReadableStream?e.writeStream(t,n,r):e.write(t,n,r)}function u(t){return e(t)===404||(t.message??String(t)).toLocaleUpperCase().includes(`ENOENT`)}export{i as chunkSize,a as concurrency,s as pipe,c as readWithSize,l as writeWithValue};

package/dist/tsdown-plugin.spec.d.ts

@@ -0,0 +1,21 @@
+//#region src/sdk/tsdown-plugin.d.ts
+type SyncEngineConfig = {
+  deps?: {
+    neverBundle?: true | string | RegExp | Array<string | RegExp> | ((id: string, parentId: string | undefined, isResolved: boolean) => boolean | null | undefined);
+  };
+};
+type ModuleMeta = Partial<Record<'name' | 'icon' | 'description' | 'source' | 'version' | 'readme', string>>;
+type ModuleMetaWithId = ModuleMeta & {
+  id: string;
+};
+export default function syncEngineModule(meta?: ModuleMeta | Array<ModuleMetaWithId> | Record<string, ModuleMeta>): {
+  name: string;
+  renderChunk(code: string, chunk: {
+    name: string;
+    isEntry: boolean;
+  }): {
+    code: string;
+  } | undefined;
+  tsdownConfig(config: SyncEngineConfig): void;
+};
+//#endregion

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@hesprs/sync-engine-sdk",
-	"version": "3.1.3",
+	"version": "3.1.5",
 	"description": "Official SDK for developing modules targeting Sync Engine, the extensible Obsidian syncing plugin.",
 	"keywords": [
 		"obsidian-plugin",
@@ -14,7 +14,7 @@
 	"license": "MIT",
 	"author": {
 		"name": "Hēsperus",
-		"email": "hesprs@outlook.com"
+		"email": "hesprs@yandex.com"
 	},
 	"repository": {
 		"type": "git",
@@ -35,6 +35,10 @@
 		"./dev": {
 			"types": "./dist/dev.spec.d.ts",
 			"default": "./dist/dev.js"
+		},
+		"./tsdown-plugin": {
+			"types": "./dist/tsdown-plugin.spec.d.ts",
+			"default": "./dist/tsdown-plugin.js"
 		}
 	},
 	"publishConfig": {
@@ -55,13 +59,13 @@
 	},
 	"devDependencies": {
 		"@repo/shared": "workspace:*",
-		"@unocss/postcss": "^66.7.5",
-		"postcss-merge-rules": "^8.0.3",
-		"solid-js": "^1.9.13",
+		"@unocss/postcss": "^66.10.0",
+		"postcss-merge-rules": "^9.0.3",
+		"solid-js": "^1.9.15",
 		"synthkernel": "./synthkernel.tgz",
 		"uni-kv": "../../uni-kv.tgz",
-		"unocss": "^66.7.5",
+		"unocss": "^66.10.0",
 		"unplugin-solid": "^2.0.0",
-		"verkit": "^0.3.2"
+		"verkit": "^0.4.0"
 	}
 }

package/dist/pipe-6bvLNkHj.js

@@ -1 +0,0 @@
-function e(e){let t=e,n=[t.status,t.res?.status,t.response?.status];for(let e of n)if(typeof e==`number`)return e}const t=2.5*1024**2;async function n({from:e,to:t,stat:n,key:a}){let o=await r(e,a,n);if(o)return i(t,a,o,n)}async function r(e,n,r){try{return r.size>t?await e.readStream(n,r):await e.read(n,r)}catch(e){if(a(e))return;throw e}}function i(e,t,n,r){return n instanceof ReadableStream?e.writeStream(t,n,r):e.write(t,n,r)}function a(t){return e(t)===404||(t.message??String(t)).toLocaleUpperCase().includes(`ENOENT`)}export{r as n,i as r,n as t};