inkdrop-model 2.11.5 → 2.11.6

package/lib/index.d.ts

@@ -1,7 +1,598 @@
-export * from './note';
-export * from './book';
-export * from './tag';
-export * from './file';
-export * from './crypto';
-export * from './validator';
-export * from './utils';
+import { ErrorObject, ValidateFunction } from "ajv";
+
+//#region json-schema/note.json.d.ts
+declare let $schema$3: string;
+declare let $id$3: string;
+declare let title$3: string;
+declare let description$3: string;
+declare let type$3: string;
+declare namespace properties$3 {
+  export namespace _id {
+    let description_1: string;
+    export { description_1 as description };
+    let type_1: string;
+    export { type_1 as type };
+    export let minLength: number;
+    export let maxLength: number;
+    export let pattern: string;
+  }
+  export namespace _rev {
+    let description_2: string;
+    export { description_2 as description };
+    let type_2: string;
+    export { type_2 as type };
+  }
+  export namespace bookId {
+    let description_3: string;
+    export { description_3 as description };
+    let type_3: string;
+    export { type_3 as type };
+    let minLength_1: number;
+    export { minLength_1 as minLength };
+    let maxLength_1: number;
+    export { maxLength_1 as maxLength };
+    let pattern_1: string;
+    export { pattern_1 as pattern };
+  }
+  export namespace title_1 {
+    let description_4: string;
+    export { description_4 as description };
+    let type_4: string;
+    export { type_4 as type };
+    let maxLength_2: number;
+    export { maxLength_2 as maxLength };
+  }
+  export { title_1 as title };
+  export namespace doctype {
+    let description_5: string;
+    export { description_5 as description };
+    let type_5: string;
+    export { type_5 as type };
+    let _enum: string[];
+    export { _enum as enum };
+  }
+  export namespace body {
+    let description_6: string;
+    export { description_6 as description };
+    let type_6: string;
+    export { type_6 as type };
+    let maxLength_3: number;
+    export { maxLength_3 as maxLength };
+  }
+  export namespace updatedAt {
+    let description_7: string;
+    export { description_7 as description };
+    let type_7: string;
+    export { type_7 as type };
+  }
+  export namespace createdAt {
+    let description_8: string;
+    export { description_8 as description };
+    let type_8: string;
+    export { type_8 as type };
+  }
+  export namespace tags {
+    let description_9: string;
+    export { description_9 as description };
+    let type_9: string;
+    export { type_9 as type };
+    export namespace items {
+      let type_10: string;
+      export { type_10 as type };
+    }
+    export let uniqueItems: boolean;
+  }
+  export namespace numOfTasks {
+    let description_10: string;
+    export { description_10 as description };
+    let type_11: string;
+    export { type_11 as type };
+  }
+  export namespace numOfCheckedTasks {
+    let description_11: string;
+    export { description_11 as description };
+    let type_12: string;
+    export { type_12 as type };
+  }
+  export namespace migratedBy {
+    let description_12: string;
+    export { description_12 as description };
+    let type_13: string;
+    export { type_13 as type };
+    let maxLength_4: number;
+    export { maxLength_4 as maxLength };
+  }
+  export namespace status {
+    let description_13: string;
+    export { description_13 as description };
+    let type_14: string;
+    export { type_14 as type };
+    let _enum_1: string[];
+    export { _enum_1 as enum };
+  }
+  export namespace share {
+    let description_14: string;
+    export { description_14 as description };
+    let type_15: string;
+    export { type_15 as type };
+    let _enum_2: string[];
+    export { _enum_2 as enum };
+  }
+  export namespace pinned {
+    let description_15: string;
+    export { description_15 as description };
+    let type_16: string;
+    export { type_16 as type };
+  }
+  export namespace timestamp {
+    let description_16: string;
+    export { description_16 as description };
+    let type_17: string;
+    export { type_17 as type };
+  }
+  export namespace _conflicts {
+    let description_17: string;
+    export { description_17 as description };
+    let type_18: string;
+    export { type_18 as type };
+    export namespace items_1 {
+      let type_19: string;
+      export { type_19 as type };
+    }
+    export { items_1 as items };
+    let uniqueItems_1: boolean;
+    export { uniqueItems_1 as uniqueItems };
+  }
+}
+declare let required$2: string[];
+declare namespace __json_default_export$2 {
+  export { $schema$3 as $schema, $id$3 as $id, title$3 as title, description$3 as description, type$3 as type, properties$3 as properties, required$2 as required };
+}
+//#endregion
+//#region src/crypto.d.ts
+type EncryptionMetadata = {
+  algorithm: string;
+  iv: string;
+  tag: string;
+};
+type EncryptedData = EncryptionMetadata & {
+  content: string | Buffer;
+};
+//#endregion
+//#region src/note.d.ts
+type TrashBookId = 'trash';
+type NoteStatus = 'none' | 'active' | 'onHold' | 'completed' | 'dropped';
+type NoteVisibility = 'private' | 'public';
+type NoteMetadata = {
+  _id: string;
+  _rev?: string;
+  bookId: string;
+  doctype: string;
+  updatedAt: number;
+  createdAt: number;
+  tags?: string[];
+  numOfTasks?: number;
+  numOfCheckedTasks?: number;
+  migratedBy?: string;
+  status?: NoteStatus;
+  share?: NoteVisibility;
+  pinned?: boolean;
+  timestamp: number;
+  _conflicts?: string[];
+};
+declare const NOTE_DOCID_PREFIX = "note:";
+type Note = NoteMetadata & {
+  title: string;
+  body: string;
+};
+type EncryptedNote = NoteMetadata & {
+  encryptedData: EncryptedData;
+};
+declare const TRASH_BOOK_ID = "trash";
+declare const NOTE_STATUS: Readonly<{
+  NONE: 'none';
+  ACTIVE: 'active';
+  ON_HOLD: 'onHold';
+  COMPLETED: 'completed';
+  DROPPED: 'dropped';
+}>;
+declare const NOTE_VISIBILITY: Readonly<{
+  PRIVATE: 'private';
+  PUBLIC: 'public';
+}>;
+declare const validateNote: ValidateFunction<Note>;
+declare const NOTE_TITLE_MAX_LENGTH: number;
+declare function createNoteId(): string;
+declare function validateNoteId(docId: string): boolean;
+//#endregion
+//#region json-schema/book.json.d.ts
+declare let $schema$2: string;
+declare let $id$2: string;
+declare let title$2: string;
+declare let description$2: string;
+declare let type$2: string;
+declare namespace properties$2 {
+  namespace _id {
+    let description_1: string;
+    export { description_1 as description };
+    let type_1: string;
+    export { type_1 as type };
+    export let minLength: number;
+    export let maxLength: number;
+    export let pattern: string;
+  }
+  namespace _rev {
+    let description_2: string;
+    export { description_2 as description };
+    let type_2: string;
+    export { type_2 as type };
+  }
+  namespace name {
+    let description_3: string;
+    export { description_3 as description };
+    let type_3: string;
+    export { type_3 as type };
+    let minLength_1: number;
+    export { minLength_1 as minLength };
+    let maxLength_1: number;
+    export { maxLength_1 as maxLength };
+  }
+  namespace updatedAt {
+    let description_4: string;
+    export { description_4 as description };
+    let type_4: string;
+    export { type_4 as type };
+  }
+  namespace createdAt {
+    let description_5: string;
+    export { description_5 as description };
+    let type_5: string;
+    export { type_5 as type };
+  }
+  namespace count {
+    let description_6: string;
+    export { description_6 as description };
+    let type_6: string;
+    export { type_6 as type };
+  }
+  namespace parentBookId {
+    let description_7: string;
+    export { description_7 as description };
+    let type_7: string[];
+    export { type_7 as type };
+  }
+  namespace order {
+    let description_8: string;
+    export { description_8 as description };
+    let type_8: string;
+    export { type_8 as type };
+  }
+  namespace icon {
+    let description_9: string;
+    export { description_9 as description };
+    let type_9: string;
+    export { type_9 as type };
+    export let oneOf: ({
+      properties: {
+        type: {
+          description: string;
+          const: string;
+        };
+        svg: {
+          description: string;
+          type: string;
+          maxLength: number;
+        };
+        docId?: undefined;
+      };
+      required: string[];
+    } | {
+      properties: {
+        type: {
+          description: string;
+          const: string;
+        };
+        docId: {
+          description: string;
+          type: string;
+          pattern: string;
+          minLength: number;
+          maxLength: number;
+        };
+        svg?: undefined;
+      };
+      required: string[];
+    })[];
+  }
+}
+declare let required$1: string[];
+declare namespace __json_default_export {
+  export { $schema$2 as $schema, $id$2 as $id, title$2 as title, description$2 as description, type$2 as type, properties$2 as properties, required$1 as required };
+}
+//#endregion
+//#region src/book.d.ts
+type BookIconInline = {
+  type: 'inline';
+  svg: string;
+};
+type BookIconFile = {
+  type: 'file';
+  docId: string;
+};
+type BookIcon = BookIconInline | BookIconFile;
+type BookMetadata = {
+  _id: string;
+  _rev?: string;
+  updatedAt: number;
+  createdAt: number;
+  count?: number;
+  parentBookId?: null | string;
+  migratedBy?: string;
+  icon?: BookIcon;
+  order?: number;
+};
+type Book = BookMetadata & {
+  name: string;
+};
+type EncryptedBook = BookMetadata & {
+  encryptedData: EncryptedData;
+};
+declare const BOOK_DOCID_PREFIX = "book:";
+declare const validateBook: ValidateFunction<Book>;
+declare function createBookId(): string;
+declare function validateBookId(docId: string): boolean;
+//#endregion
+//#region json-schema/tag.json.d.ts
+declare let $schema$1: string;
+declare let $id$1: string;
+declare let title$1: string;
+declare let description$1: string;
+declare let type$1: string;
+declare namespace properties$1 {
+  namespace _id {
+    let description_1: string;
+    export { description_1 as description };
+    let type_1: string;
+    export { type_1 as type };
+    export let minLength: number;
+    export let maxLength: number;
+    export let pattern: string;
+  }
+  namespace _rev {
+    let description_2: string;
+    export { description_2 as description };
+    let type_2: string;
+    export { type_2 as type };
+  }
+  namespace name {
+    let description_3: string;
+    export { description_3 as description };
+    let type_3: string;
+    export { type_3 as type };
+    let maxLength_1: number;
+    export { maxLength_1 as maxLength };
+  }
+  namespace count {
+    let description_4: string;
+    export { description_4 as description };
+    let type_4: string;
+    export { type_4 as type };
+  }
+  namespace color {
+    let description_5: string;
+    export { description_5 as description };
+    let type_5: string;
+    export { type_5 as type };
+    let _enum: string[];
+    export { _enum as enum };
+  }
+  namespace updatedAt {
+    let description_6: string;
+    export { description_6 as description };
+    let type_6: string;
+    export { type_6 as type };
+  }
+  namespace createdAt {
+    let description_7: string;
+    export { description_7 as description };
+    let type_7: string;
+    export { type_7 as type };
+  }
+}
+declare let required: string[];
+declare namespace __json_default_export$3 {
+  export { $schema$1 as $schema, $id$1 as $id, title$1 as title, description$1 as description, type$1 as type, properties$1 as properties, required };
+}
+//#endregion
+//#region src/tag.d.ts
+type TagColor = 'default' | 'red' | 'orange' | 'yellow' | 'olive' | 'green' | 'teal' | 'blue' | 'violet' | 'purple' | 'pink' | 'brown' | 'grey' | 'black';
+declare const TAG_COLOR: Readonly<{
+  DEFAULT: 'default';
+  RED: 'red';
+  ORANGE: 'orange';
+  YELLOW: 'yellow';
+  OLIVE: 'olive';
+  GREEN: 'green';
+  TEAL: 'teal';
+  BLUE: 'blue';
+  VIOLET: 'violet';
+  PURPLE: 'purple';
+  PINK: 'pink';
+  BROWN: 'brown';
+  GREY: 'grey';
+  BLACK: 'black';
+}>;
+type TagMetadata = {
+  _id: string;
+  _rev?: string;
+  count?: number;
+  color: TagColor;
+  updatedAt: number;
+  createdAt: number;
+};
+type Tag = TagMetadata & {
+  name: string;
+};
+type EncryptedTag = TagMetadata & {
+  encryptedData: EncryptedData;
+};
+declare const TAG_DOCID_PREFIX = "tag:";
+declare const validateTag: ValidateFunction<Tag>;
+declare function createTagId(): string;
+declare function validateTagId(docId: string): boolean;
+//#endregion
+//#region json-schema/file.json.d.ts
+declare let $schema: string;
+declare let $id: string;
+declare let title: string;
+declare let description: string;
+declare let type: string;
+declare namespace properties {
+  namespace _id {
+    let description_1: string;
+    export { description_1 as description };
+    let type_1: string;
+    export { type_1 as type };
+    export let minLength: number;
+    export let maxLength: number;
+    export let pattern: string;
+  }
+  namespace _rev {
+    let description_2: string;
+    export { description_2 as description };
+    let type_2: string;
+    export { type_2 as type };
+  }
+  namespace name {
+    let description_3: string;
+    export { description_3 as description };
+    let type_3: string;
+    export { type_3 as type };
+    let minLength_1: number;
+    export { minLength_1 as minLength };
+    let maxLength_1: number;
+    export { maxLength_1 as maxLength };
+  }
+  namespace createdAt {
+    let description_4: string;
+    export { description_4 as description };
+    let type_4: string;
+    export { type_4 as type };
+  }
+  namespace contentType {
+    let description_5: string;
+    export { description_5 as description };
+    let type_5: string;
+    export { type_5 as type };
+    let _enum: string[];
+    export { _enum as enum };
+    let maxLength_2: number;
+    export { maxLength_2 as maxLength };
+  }
+  namespace contentLength {
+    let description_6: string;
+    export { description_6 as description };
+    let type_6: string;
+    export { type_6 as type };
+    export let maximum: number;
+  }
+  namespace publicIn {
+    let description_7: string;
+    export { description_7 as description };
+    let type_7: string;
+    export { type_7 as type };
+    export namespace items {
+      let type_8: string;
+      export { type_8 as type };
+    }
+    export let uniqueItems: boolean;
+  }
+  namespace _attachments {
+    let description_8: string;
+    export { description_8 as description };
+    let type_9: string;
+    export { type_9 as type };
+    export namespace properties_1 {
+      namespace index {
+        let description_9: string;
+        export { description_9 as description };
+        let type_10: string;
+        export { type_10 as type };
+        export namespace properties_2 {
+          namespace content_type {
+            let description_10: string;
+            export { description_10 as description };
+            let type_11: string;
+            export { type_11 as type };
+            let _enum_1: string[];
+            export { _enum_1 as enum };
+          }
+          namespace data {
+            let description_11: string;
+            export { description_11 as description };
+            let type_12: string[];
+            export { type_12 as type };
+          }
+        }
+        export { properties_2 as properties };
+        export let required: string[];
+      }
+    }
+    export { properties_1 as properties };
+    let required_1: string[];
+    export { required_1 as required };
+  }
+}
+declare let required_2: string[];
+declare namespace __json_default_export$1 {
+  export { $schema, $id, title, description, type, properties, required_2 as required };
+}
+//#endregion
+//#region src/file.d.ts
+type ImageFileType = 'image/png' | 'image/jpeg' | 'image/jpg' | 'image/svg+xml' | 'image/gif' | 'image/heic' | 'image/heif';
+declare const supportedImageFileTypes: ReadonlyArray<ImageFileType>;
+declare const SUPPORTED_IMAGE_MIME_TYPES: {
+  readonly [mime: string]: ImageFileType;
+};
+declare const maxAttachmentFileSize: number;
+type FileAttachmentItem = {
+  digest?: string;
+  content_type: ImageFileType;
+  data: Buffer | string;
+  length?: number;
+};
+type File = {
+  _id: string;
+  _rev?: string;
+  name: string;
+  createdAt: number;
+  contentType: ImageFileType;
+  contentLength: number;
+  publicIn: string[];
+  _attachments: {
+    index: FileAttachmentItem;
+  };
+  md5digest?: string;
+};
+type EncryptedFile = File & {
+  encryptionData: EncryptionMetadata;
+};
+declare const FILE_DOCID_PREFIX = "file:";
+declare const validateFile: ValidateFunction<File>;
+declare function createFileId(): string;
+declare function validateFileId(docId: string): boolean;
+//#endregion
+//#region src/validator.d.ts
+declare function validationErrorsToMessage(errors: ErrorObject[]): string;
+declare class InvalidDataError extends Error {
+  name: string;
+  errors: ErrorObject[];
+  constructor(message: string, errors: ErrorObject[]);
+}
+declare function validateDocId(prefix: string, docId: string): boolean;
+//#endregion
+//#region src/utils.d.ts
+declare function createDocId(prefix: string): string;
+//#endregion
+export { BOOK_DOCID_PREFIX, Book, BookIcon, BookIconFile, BookIconInline, BookMetadata, __json_default_export as BookSchema, EncryptedBook, EncryptedData, EncryptedFile, EncryptedNote, EncryptedTag, EncryptionMetadata, FILE_DOCID_PREFIX, File, FileAttachmentItem, __json_default_export$1 as FileSchema, ImageFileType, InvalidDataError, NOTE_DOCID_PREFIX, NOTE_STATUS, NOTE_TITLE_MAX_LENGTH, NOTE_VISIBILITY, Note, NoteMetadata, __json_default_export$2 as NoteSchema, NoteStatus, NoteVisibility, SUPPORTED_IMAGE_MIME_TYPES, TAG_COLOR, TAG_DOCID_PREFIX, TRASH_BOOK_ID, Tag, TagColor, TagMetadata, __json_default_export$3 as TagSchema, TrashBookId, createBookId, createDocId, createFileId, createNoteId, createTagId, maxAttachmentFileSize, supportedImageFileTypes, validateBook, validateBookId, validateDocId, validateFile, validateFileId, validateNote, validateNoteId, validateTag, validateTagId, validationErrorsToMessage };
+//# sourceMappingURL=index.d.ts.map