@vrtmrz/livesync-commonlib 0.1.0-rc.0

package/dist/common/models/auth.type.d.ts

@@ -0,0 +1,41 @@
+export type CouchDBCredentials = BasicCredentials | JWTCredentials;
+export type JWTAlgorithm = "HS256" | "HS512" | "ES256" | "ES512" | "";
+export type Credential = {
+    username: string;
+    password: string;
+};
+export type BasicCredentials = {
+    username: string;
+    password: string;
+    type: "basic";
+};
+export type JWTCredentials = {
+    jwtAlgorithm: JWTAlgorithm;
+    jwtKey: string;
+    jwtKid: string;
+    jwtSub: string;
+    jwtExpDuration: number;
+    type: "jwt";
+};
+export interface JWTHeader {
+    alg: string;
+    typ: string;
+    kid?: string;
+}
+export interface JWTPayload {
+    sub: string;
+    exp: number;
+    iss?: string;
+    iat: number;
+    [key: string]: unknown;
+}
+export interface JWTParams {
+    header: JWTHeader;
+    payload: JWTPayload;
+    credentials: JWTCredentials;
+}
+export interface PreparedJWT {
+    header: JWTHeader;
+    payload: JWTPayload;
+    token: string;
+}

package/dist/common/models/db.const.d.ts

@@ -0,0 +1,20 @@
+import type { DocumentID } from "./db.type.js";
+export declare const VERSIONING_DOCID: DocumentID;
+export declare const MILESTONE_DOCID: DocumentID;
+export declare const NODEINFO_DOCID: DocumentID;
+export declare const SYNCINFO_ID: DocumentID;
+export declare const EntryTypes: {
+    readonly NOTE_LEGACY: "notes";
+    readonly NOTE_BINARY: "newnote";
+    readonly NOTE_PLAIN: "plain";
+    readonly INTERNAL_FILE: "internalfile";
+    readonly CHUNK: "leaf";
+    readonly CHUNK_PACK: "chunkpack";
+    readonly VERSION_INFO: "versioninfo";
+    readonly SYNC_INFO: "syncinfo";
+    readonly SYNC_PARAMETERS: "sync-parameters";
+    readonly MILESTONE_INFO: "milestoneinfo";
+    readonly NODE_INFO: "nodeinfo";
+};
+export declare const NoteTypes: ("notes" | "newnote" | "plain")[];
+export declare const ChunkTypes: ("leaf" | "chunkpack")[];

package/dist/common/models/db.const.js

@@ -0,0 +1,28 @@
+const VERSIONING_DOCID = "obsydian_livesync_version";
+const MILESTONE_DOCID = "_local/obsydian_livesync_milestone";
+const NODEINFO_DOCID = "_local/obsydian_livesync_nodeinfo";
+const SYNCINFO_ID = "syncinfo";
+const EntryTypes = {
+  NOTE_LEGACY: "notes",
+  NOTE_BINARY: "newnote",
+  NOTE_PLAIN: "plain",
+  INTERNAL_FILE: "internalfile",
+  CHUNK: "leaf",
+  CHUNK_PACK: "chunkpack",
+  VERSION_INFO: "versioninfo",
+  SYNC_INFO: "syncinfo",
+  SYNC_PARAMETERS: "sync-parameters",
+  MILESTONE_INFO: "milestoneinfo",
+  NODE_INFO: "nodeinfo"
+};
+const NoteTypes = [EntryTypes.NOTE_LEGACY, EntryTypes.NOTE_BINARY, EntryTypes.NOTE_PLAIN];
+const ChunkTypes = [EntryTypes.CHUNK, EntryTypes.CHUNK_PACK];
+export {
+  ChunkTypes,
+  EntryTypes,
+  MILESTONE_DOCID,
+  NODEINFO_DOCID,
+  NoteTypes,
+  SYNCINFO_ID,
+  VERSIONING_DOCID
+};

package/dist/common/models/db.definition.d.ts

@@ -0,0 +1,56 @@
+import type { MILESTONE_DOCID, NODEINFO_DOCID } from "./db.const.js";
+import type { AnyEntry, ChunkVersionRange, DatabaseEntry, EntryChunkPack, EntryLeaf, EntryTypes, EntryVersionInfo, InternalFileEntry, LoadedEntry, MetaEntry, NewEntry, NoteEntry, PlainEntry } from "./db.type.js";
+import type { TweakValues } from "./tweak.definition.js";
+export type NodeKey = string;
+export interface DeviceInfo {
+    /**
+     * Name of the device (Initially from deviceAndVaultName setting, configurable).
+     */
+    device_name: string;
+    /**
+     * Vault name (From vaultName setting).
+     */
+    vault_name: string;
+    /**
+     * Obsidian App version of the device.
+     */
+    app_version: string;
+    /**
+     * Plugin version of the device.
+     */
+    plugin_version: string;
+    progress: string;
+}
+export interface NodeData extends DeviceInfo {
+    /**
+     * Epoch time in milliseconds when the device last connected.
+     */
+    last_connected: number;
+}
+export interface EntryMilestoneInfo extends DatabaseEntry {
+    _id: typeof MILESTONE_DOCID;
+    type: EntryTypes["MILESTONE_INFO"];
+    created: number;
+    accepted_nodes: string[];
+    node_info: {
+        [key: NodeKey]: NodeData;
+    };
+    locked: boolean;
+    cleaned?: boolean;
+    node_chunk_info: {
+        [key: NodeKey]: ChunkVersionRange;
+    };
+    tweak_values: {
+        [key: NodeKey]: TweakValues;
+    };
+}
+export interface EntryNodeInfo extends DatabaseEntry {
+    _id: typeof NODEINFO_DOCID;
+    type: EntryTypes["NODE_INFO"];
+    nodeid: string;
+    v20220607?: boolean;
+}
+export type EntryBody = NoteEntry | NewEntry | PlainEntry | InternalFileEntry;
+export type EntryDoc = EntryBody | LoadedEntry | EntryLeaf | EntryVersionInfo | EntryMilestoneInfo | EntryNodeInfo | EntryChunkPack;
+export type EntryDocResponse = EntryDoc & PouchDB.Core.IdMeta & PouchDB.Core.GetMeta;
+export declare function isMetaEntry(entry: AnyEntry): entry is MetaEntry;

package/dist/common/models/db.definition.js

@@ -0,0 +1,6 @@
+function isMetaEntry(entry) {
+  return "children" in entry;
+}
+export {
+  isMetaEntry
+};

package/dist/common/models/db.type.d.ts

@@ -0,0 +1,142 @@
+import type { TaggedType } from "octagonal-wheels/common/types";
+import type { EntryTypes, SYNCINFO_ID } from "./db.const.js";
+export type FilePath = TaggedType<string, "FilePath">;
+export type FilePathWithPrefixLC = TaggedType<string, "FilePathWithPrefixLC">;
+export type FilePathWithPrefix = TaggedType<string, "FilePathWithPrefix"> | FilePath | FilePathWithPrefixLC;
+export type DocumentID = TaggedType<string, "documentId">;
+export type EntryType = (typeof EntryTypes)[keyof typeof EntryTypes];
+export type EntryTypes = typeof EntryTypes;
+export type EntryTypeNotes = EntryTypes["NOTE_BINARY"] | EntryTypes["NOTE_PLAIN"];
+export type EntryTypeNotesWithLegacy = EntryTypeNotes | EntryTypes["NOTE_LEGACY"];
+/**
+ * Represents an entry in the database.
+ */
+export interface DatabaseEntry {
+    /**
+     * The ID of the document.
+     */
+    _id: DocumentID;
+    /**
+     * The revision of the document.
+     */
+    _rev?: string;
+    /**
+     * Deleted flag.
+     */
+    _deleted?: boolean;
+    /**
+     * Conflicts (if exists).
+     */
+    _conflicts?: string[];
+}
+/**
+ * Represents the base structure for an entry that represents a file.
+ */
+export type EntryBase = {
+    /**
+     * The creation time of the file.
+     */
+    ctime: number;
+    /**
+     * The modification time of the file.
+     */
+    mtime: number;
+    /**
+     * The size of the file.
+     */
+    size: number;
+    /**
+     * Deleted flag.
+     */
+    deleted?: boolean;
+};
+export type EdenChunk = {
+    data: string;
+    epoch: number;
+};
+export type EntryWithEden = {
+    eden: Record<DocumentID, EdenChunk>;
+};
+export type NoteEntry = DatabaseEntry & EntryBase & EntryWithEden & {
+    /**
+     * The path of the file.
+     */
+    path: FilePathWithPrefix;
+    /**
+     * Contents of the file.
+     */
+    data: string | string[];
+    /**
+     * The type of the entry.
+     */
+    type: EntryTypes["NOTE_LEGACY"];
+};
+export type NewEntry = DatabaseEntry & EntryBase & EntryWithEden & {
+    /**
+     * The path of the file.
+     */
+    path: FilePathWithPrefix;
+    /**
+     * Chunk IDs indicating the contents of the file.
+     */
+    children: string[];
+    /**
+     * The type of the entry.
+     */
+    type: EntryTypes["NOTE_BINARY"];
+};
+export type PlainEntry = DatabaseEntry & EntryBase & EntryWithEden & {
+    /**
+     * The path of the file.
+     */
+    path: FilePathWithPrefix;
+    /**
+     * Chunk IDs indicating the contents of the file.
+     */
+    children: string[];
+    /**
+     * The type of the entry.
+     */
+    type: EntryTypes["NOTE_PLAIN"];
+};
+export type InternalFileEntry = DatabaseEntry & NewEntry & EntryBase & {
+    deleted?: boolean;
+};
+export type AnyEntry = NoteEntry | NewEntry | PlainEntry | InternalFileEntry;
+export type LoadedEntry = AnyEntry & {
+    data: string | string[];
+    datatype: EntryTypeNotes;
+};
+export type SavingEntry = AnyEntry & {
+    data: Blob;
+    datatype: EntryTypeNotes;
+};
+export type MetaEntry = AnyEntry & {
+    children: string[];
+};
+export type EntryLeaf = DatabaseEntry & {
+    type: EntryTypes["CHUNK"];
+    data: string;
+    isCorrupted?: boolean;
+};
+export type EntryChunkPack = DatabaseEntry & {
+    type: EntryTypes["CHUNK_PACK"];
+    data: string;
+};
+export interface EntryVersionInfo extends DatabaseEntry {
+    type: EntryTypes["VERSION_INFO"];
+    version: number;
+}
+export interface EntryHasPath {
+    path: FilePathWithPrefix | FilePath;
+}
+export interface ChunkVersionRange {
+    min: number;
+    max: number;
+    current: number;
+}
+export interface SyncInfo extends DatabaseEntry {
+    _id: typeof SYNCINFO_ID;
+    type: EntryTypes["SYNC_INFO"];
+    data: string;
+}

package/dist/common/models/diff.definition.d.ts

@@ -0,0 +1,16 @@
+import type { AUTO_MERGED, CANCELLED, MISSING_OR_ERROR, NOT_CONFLICTED } from "./shared.const.symbols.js";
+export type diff_result_leaf = {
+    rev: string;
+    data: string;
+    ctime: number;
+    mtime: number;
+    deleted?: boolean;
+};
+export type dmp_result = Array<[number, string]>;
+export type diff_result = {
+    left: diff_result_leaf;
+    right: diff_result_leaf;
+    diff: dmp_result;
+};
+export type DIFF_CHECK_RESULT_AUTO = typeof CANCELLED | typeof AUTO_MERGED | typeof NOT_CONFLICTED | typeof MISSING_OR_ERROR;
+export type diff_check_result = DIFF_CHECK_RESULT_AUTO | diff_result;

package/dist/common/models/fileaccess.const.d.ts

@@ -0,0 +1,7 @@
+export declare const CHeader = "h:";
+export declare const PSCHeader = "ps:";
+export declare const PSCHeaderEnd = "ps;";
+export declare const ICHeader = "i:";
+export declare const ICHeaderEnd = "i;";
+export declare const ICHeaderLength: number;
+export declare const ICXHeader = "ix:";

package/dist/common/models/fileaccess.const.js

@@ -0,0 +1,16 @@
+const CHeader = "h:";
+const PSCHeader = "ps:";
+const PSCHeaderEnd = "ps;";
+const ICHeader = "i:";
+const ICHeaderEnd = "i;";
+const ICHeaderLength = ICHeader.length;
+const ICXHeader = "ix:";
+export {
+  CHeader,
+  ICHeader,
+  ICHeaderEnd,
+  ICHeaderLength,
+  ICXHeader,
+  PSCHeader,
+  PSCHeaderEnd
+};

package/dist/common/models/fileaccess.type.d.ts

@@ -0,0 +1,72 @@
+import type { FilePath, FilePathWithPrefix } from "./db.type.js";
+export type UXStat = {
+    size: number;
+    mtime: number;
+    ctime: number;
+    type: "file" | "folder";
+};
+export type UXFileInfoStub = {
+    name: string;
+    path: FilePath | FilePathWithPrefix;
+    stat: UXStat;
+    deleted?: boolean;
+    isFolder?: false;
+    isInternal?: boolean;
+};
+export type UXFileInfo = UXFileInfoStub & {
+    body: Blob;
+};
+export type UXAbstractInfoStub = UXFileInfoStub | UXFolderInfo;
+export type UXInternalFileInfoStub = {
+    name: string;
+    path: FilePath | FilePathWithPrefix;
+    deleted?: boolean;
+    isFolder?: false;
+    isInternal: true;
+    stat: undefined;
+};
+export type UXFolderInfo = {
+    name: string;
+    path: FilePath | FilePathWithPrefix;
+    deleted?: boolean;
+    isFolder: true;
+    children: UXFileInfoStub[];
+    parent: FilePath | FilePathWithPrefix | undefined;
+};
+export type UXDataWriteOptions = {
+    /**
+     * Time of creation, represented as a unix timestamp, in milliseconds.
+     * Omit this if you want to keep the default behaviour.
+     * @public
+     * */
+    ctime?: number;
+    /**
+     * Time of last modification, represented as a unix timestamp, in milliseconds.
+     * Omit this if you want to keep the default behaviour.
+     * @public
+     */
+    mtime?: number;
+};
+export type CacheData = string | ArrayBuffer;
+export type FileEventType = "CREATE" | "DELETE" | "CHANGED" | "RENAME" | "INTERNAL";
+export type FileEventArgs = {
+    file: UXFileInfoStub | UXInternalFileInfoStub;
+    cache?: CacheData;
+    oldPath?: string;
+    ctx?: unknown;
+};
+export type FileEventItem = {
+    type: FileEventType;
+    args: FileEventArgs;
+    key: string;
+    skipBatchWait?: boolean;
+    cancelled?: boolean;
+    batched?: boolean;
+};
+export interface FileWithFileStat extends Omit<UXStat, "type"> {
+    path: FilePath;
+}
+export interface FileWithStatAsProp {
+    path: FilePath;
+    stat: Omit<UXStat, "type">;
+}

package/dist/common/models/redflag.const.d.ts

@@ -0,0 +1,32 @@
+import type { FilePath } from "./db.type.js";
+export declare const PREFIXMD_LOGFILE = "livesync_log_";
+export declare const PREFIXMD_LOGFILE_UC = "LIVESYNC_LOG_";
+export declare const FlagFilesOriginal: {
+    readonly SUSPEND_ALL: FilePath;
+    readonly REBUILD_ALL: FilePath;
+    readonly FETCH_ALL: FilePath;
+};
+export declare const FlagFilesHumanReadable: {
+    readonly REBUILD_ALL: FilePath;
+    readonly FETCH_ALL: FilePath;
+};
+/**
+ * @deprecated Use `FlagFilesOriginal.SUSPEND_ALL` instead.
+ */
+export declare const FLAGMD_REDFLAG: FilePath;
+/**
+ * @deprecated Use `FlagFilesHumanReadable.REBUILD_ALL` instead.
+ */
+export declare const FLAGMD_REDFLAG2: FilePath;
+/**
+ * @deprecated Use `FlagFilesHumanReadable.FETCH_ALL` instead.
+ */
+export declare const FLAGMD_REDFLAG2_HR: FilePath;
+/**
+ * @deprecated Use `FlagFilesOriginal.FETCH_ALL` instead.
+ */
+export declare const FLAGMD_REDFLAG3: FilePath;
+/**
+ * @deprecated Use `FlagFilesHumanReadable.FETCH_ALL` instead.
+ */
+export declare const FLAGMD_REDFLAG3_HR: FilePath;

package/dist/common/models/redflag.const.js

@@ -0,0 +1,27 @@
+const PREFIXMD_LOGFILE = "livesync_log_";
+const PREFIXMD_LOGFILE_UC = "LIVESYNC_LOG_";
+const FlagFilesOriginal = {
+  SUSPEND_ALL: "redflag.md",
+  REBUILD_ALL: "redflag2.md",
+  FETCH_ALL: "redflag3.md"
+};
+const FlagFilesHumanReadable = {
+  REBUILD_ALL: "flag_rebuild.md",
+  FETCH_ALL: "flag_fetch.md"
+};
+const FLAGMD_REDFLAG = FlagFilesOriginal.SUSPEND_ALL;
+const FLAGMD_REDFLAG2 = FlagFilesOriginal.REBUILD_ALL;
+const FLAGMD_REDFLAG2_HR = FlagFilesHumanReadable.REBUILD_ALL;
+const FLAGMD_REDFLAG3 = FlagFilesOriginal.FETCH_ALL;
+const FLAGMD_REDFLAG3_HR = FlagFilesHumanReadable.FETCH_ALL;
+export {
+  FLAGMD_REDFLAG,
+  FLAGMD_REDFLAG2,
+  FLAGMD_REDFLAG2_HR,
+  FLAGMD_REDFLAG3,
+  FLAGMD_REDFLAG3_HR,
+  FlagFilesHumanReadable,
+  FlagFilesOriginal,
+  PREFIXMD_LOGFILE,
+  PREFIXMD_LOGFILE_UC
+};

package/dist/common/models/setting.const.d.ts

@@ -0,0 +1,49 @@
+export declare const SETTING_VERSION_INITIAL = 0;
+export declare const SETTING_VERSION_SUPPORT_CASE_INSENSITIVE = 10;
+export declare const CURRENT_SETTING_VERSION = 10;
+export declare const RemoteTypes: {
+    readonly REMOTE_COUCHDB: "";
+    readonly REMOTE_MINIO: "MINIO";
+    readonly REMOTE_P2P: "ONLY_P2P";
+};
+export declare const REMOTE_COUCHDB: "";
+export declare const REMOTE_MINIO: "MINIO";
+export declare const REMOTE_P2P: "ONLY_P2P";
+export declare const E2EEAlgorithmNames: {
+    readonly "": "V1: Legacy";
+    readonly v2: "V2: AES-256-GCM With HKDF";
+    readonly forceV1: "Force-V1: Force Legacy (Not recommended)";
+};
+export declare const E2EEAlgorithms: {
+    readonly V1: "";
+    readonly V2: "v2";
+    readonly ForceV1: "forceV1";
+};
+export declare const HashAlgorithms: {
+    readonly XXHASH32: "xxhash32";
+    readonly XXHASH64: "xxhash64";
+    readonly MIXED_PUREJS: "mixed-purejs";
+    readonly SHA1: "sha1";
+    readonly LEGACY: "";
+};
+export declare const ChunkAlgorithmNames: {
+    readonly v1: "V1: Legacy";
+    readonly v2: "V2: Simple (Default)";
+    readonly "v2-segmenter": "V2.5: Lexical chunks";
+    readonly "v3-rabin-karp": "V3: Fine deduplication";
+};
+export declare const ChunkAlgorithms: {
+    readonly V1: "v1";
+    readonly V2: "v2";
+    readonly V2Segmenter: "v2-segmenter";
+    readonly RabinKarp: "v3-rabin-karp";
+};
+export declare const MODE_SELECTIVE = 0;
+export declare const MODE_AUTOMATIC = 1;
+export declare const MODE_PAUSED = 2;
+export declare const MODE_SHINY = 3;
+export declare const NetworkWarningStyles: {
+    readonly BANNER: "";
+    readonly ICON: "icon";
+    readonly HIDDEN: "hidden";
+};

package/dist/common/models/setting.const.defaults.d.ts

@@ -0,0 +1,3 @@
+import { type ObsidianLiveSyncSettings, type P2PSyncSetting } from "./setting.type.js";
+export declare const P2P_DEFAULT_SETTINGS: P2PSyncSetting;
+export declare const DEFAULT_SETTINGS: ObsidianLiveSyncSettings;