@hesprs/sync-engine-sdk 3.1.3 → 3.1.4

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

@@ -113,8 +113,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 +149,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 +159,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;
@@ -580,6 +570,8 @@ type MiscellaneousSettingTranslations = {
   headerKeyPlaceholder: string;
   headerValuePlaceholder: string;
   addSecretHeader: string;
+  avoidAutoSyncWhenOffline: string;
+  avoidAutoSyncWhenOfflineDescription: string;
 };
 //#endregion
 //#region src/components/module-management/index.d.ts
@@ -779,6 +771,7 @@ declare class Scheduler {
     registerEvent: (ref: EventRef) => void;
     app: App;
     isIdle: Ref<boolean>;
+    dispatch: Dispatch<Events>;
   });
   settings: {
     startupSync: TogglableValue;
@@ -786,6 +779,7 @@ declare class Scheduler {
     realtimeSync: TogglableValue;
     exclusionRules: Array<GlobMatchRule>;
     inclusionRules: Array<GlobMatchRule>;
+    avoidAutoSyncWhenOffline: boolean;
   };
   private readonly requestSync;
   start: () => void;
@@ -822,6 +816,7 @@ type Translations = MergeSingleKey<InternalModules, 'i18n'>;
 declare function prefixWrapper(original: Fs, prefix: string): WrappedFs;
 //#endregion
 //#region src/utils/pipe.d.ts
+declare const chunkSize: number, concurrency: number;
 declare function pipe({ from, to, stat, key }: {
   from: Fs;
   to: Fs;
@@ -835,4 +830,4 @@ declare function writeWithValue(fs: Fs, key: string, value: Binary | ReadableStr
 declare function digOriginal(wrapped: Fs): RootFs;
 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, 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, chunkSize, concurrency, digOriginal, generateEditableList, pipe, prefixWrapper, reactivelyValidate, readWithSize, s, setNeedMigration, writeWithValue };

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,22 @@
+//#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;
+};
+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 { syncEngineModule as default };

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@hesprs/sync-engine-sdk",
-	"version": "3.1.3",
+	"version": "3.1.4",
 	"description": "Official SDK for developing modules targeting Sync Engine, the extensible Obsidian syncing plugin.",
 	"keywords": [
 		"obsidian-plugin",
@@ -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": {

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};