inkdrop-model 2.7.0 → 2.7.2

package/README.md

@@ -1,7 +1,7 @@
 Inkdrop Model
 ==================
 
-Inkdrop data model definitions in json-schema and flowtype
+Inkdrop data model definitions in json-schema and TypeScript
 
 ## Documentations
 
@@ -15,9 +15,9 @@ npm install inkdrop-model
 
 ## Usage
 
-### Flowtype
+### TypeScript
 
-```javascript
+```typescript
 import type { Note, Book, Tag, File } from 'inkdrop-model'
 ```
 

package/lib/book.d.ts

@@ -1,20 +1,20 @@
-import type { ValidateFunction } from 'ajv';
-import BookSchema from '../json-schema/book.json';
-import type { EncryptedData } from './crypto';
-export declare type BookMetadata = {
-    _id: string;
-    _rev?: string;
-    updatedAt: number;
-    createdAt: number;
-    count?: number;
-    parentBookId?: null | string;
-    migratedBy?: string;
-};
-export declare type Book = BookMetadata & {
-    name: string;
-};
-export declare type EncryptedBook = BookMetadata & {
-    encryptedData: EncryptedData;
-};
-declare const validateBook: ValidateFunction<Book>;
-export { BookSchema, validateBook };
+import type { ValidateFunction } from 'ajv';
+import BookSchema from '../json-schema/book.json';
+import type { EncryptedData } from './crypto';
+export type BookMetadata = {
+    _id: string;
+    _rev?: string;
+    updatedAt: number;
+    createdAt: number;
+    count?: number;
+    parentBookId?: null | string;
+    migratedBy?: string;
+};
+export type Book = BookMetadata & {
+    name: string;
+};
+export type EncryptedBook = BookMetadata & {
+    encryptedData: EncryptedData;
+};
+declare const validateBook: ValidateFunction<Book>;
+export { BookSchema, validateBook };

package/lib/crypto.d.ts

@@ -1,9 +1,9 @@
-/// <reference types="node" />
-export declare type EncryptionMetadata = {
-    algorithm: string;
-    iv: string;
-    tag: string;
-};
-export declare type EncryptedData = EncryptionMetadata & {
-    content: string | Buffer;
-};
+/// <reference types="node" />
+export type EncryptionMetadata = {
+    algorithm: string;
+    iv: string;
+    tag: string;
+};
+export type EncryptedData = EncryptionMetadata & {
+    content: string | Buffer;
+};

package/lib/file.d.ts

@@ -1,34 +1,34 @@
-/// <reference types="node" />
-import type { ValidateFunction } from 'ajv';
-import FileSchema from '../json-schema/file.json';
-import type { EncryptionMetadata } from './crypto';
-export declare type ImageFileType = 'image/png' | 'image/jpeg' | 'image/jpg' | 'image/svg+xml' | 'image/gif' | 'image/heic' | 'image/heif';
-export declare const supportedImageFileTypes: ReadonlyArray<ImageFileType>;
-export declare const SUPPORTED_IMAGE_MIME_TYPES: {
-    readonly [mime: string]: ImageFileType;
-};
-export declare const maxAttachmentFileSize: number;
-export declare type FileAttachmentItem = {
-    digest?: string;
-    content_type: ImageFileType;
-    data: Buffer | string;
-    length?: number;
-};
-export declare type File = {
-    _id: string;
-    _rev?: string;
-    name: string;
-    createdAt: number;
-    contentType: ImageFileType;
-    contentLength: number;
-    publicIn: string[];
-    _attachments: {
-        index: FileAttachmentItem;
-    };
-    md5digest?: string;
-};
-export declare type EncryptedFile = File & {
-    encryptionData: EncryptionMetadata;
-};
-declare const validateFile: ValidateFunction<File>;
-export { FileSchema, validateFile };
+/// <reference types="node" />
+import type { ValidateFunction } from 'ajv';
+import FileSchema from '../json-schema/file.json';
+import type { EncryptionMetadata } from './crypto';
+export type ImageFileType = 'image/png' | 'image/jpeg' | 'image/jpg' | 'image/svg+xml' | 'image/gif' | 'image/heic' | 'image/heif';
+export declare const supportedImageFileTypes: ReadonlyArray<ImageFileType>;
+export declare const SUPPORTED_IMAGE_MIME_TYPES: {
+    readonly [mime: string]: ImageFileType;
+};
+export declare const maxAttachmentFileSize: number;
+export type FileAttachmentItem = {
+    digest?: string;
+    content_type: ImageFileType;
+    data: Buffer | string;
+    length?: number;
+};
+export type File = {
+    _id: string;
+    _rev?: string;
+    name: string;
+    createdAt: number;
+    contentType: ImageFileType;
+    contentLength: number;
+    publicIn: string[];
+    _attachments: {
+        index: FileAttachmentItem;
+    };
+    md5digest?: string;
+};
+export type EncryptedFile = File & {
+    encryptionData: EncryptionMetadata;
+};
+declare const validateFile: ValidateFunction<File>;
+export { FileSchema, validateFile };

package/lib/index.d.ts

@@ -1,6 +1,6 @@
-export * from './note';
-export * from './book';
-export * from './tag';
-export * from './file';
-export * from './crypto';
-export * from './validator';
+export * from './note';
+export * from './book';
+export * from './tag';
+export * from './file';
+export * from './crypto';
+export * from './validator';

package/lib/index.esm.js

@@ -1,47 +1,295 @@
-export { default as NoteSchema } from '../json-schema/note.json';
 import validator from '../validators/note';
-export { default as BookSchema } from '../json-schema/book.json';
 import validator$1 from '../validators/book';
-export { default as TagSchema } from '../json-schema/tag.json';
 import validator$2 from '../validators/tag';
-export { default as FileSchema } from '../json-schema/file.json';
 import validator$3 from '../validators/file';
 
-var TRASH_BOOK_ID = 'trash';
-var NOTE_STATUS = {
-    NONE: 'none',
-    ACTIVE: 'active',
-    ON_HOLD: 'onHold',
-    COMPLETED: 'completed',
-    DROPPED: 'dropped'
-};
-var NOTE_VISIBILITY = {
-    PRIVATE: 'private',
-    PUBLIC: 'public'
-};
+var $schema$3 = "http://json-schema.org/draft-07/schema#";
+var $id$3 = "note";
+var title$3 = "Note";
+var description$3 = "A note data";
+var type$3 = "object";
+var properties$3 = {
+	_id: {
+		description: "The unique document ID which should start with `note:` and the remains are randomly generated string",
+		type: "string",
+		minLength: 6,
+		maxLength: 128,
+		pattern: "^note:"
+	},
+	_rev: {
+		description: "This is a CouchDB specific field. The current MVCC-token/revision of this document (mandatory and immutable).",
+		type: "string"
+	},
+	bookId: {
+		description: "The notebook ID",
+		type: "string",
+		minLength: 5,
+		maxLength: 128,
+		pattern: "^(book:|trash$)"
+	},
+	title: {
+		description: "The note title",
+		type: "string",
+		maxLength: 128
+	},
+	doctype: {
+		description: "The format type of the body field. It currently can take markdown only, reserved for the future",
+		type: "string",
+		"enum": [
+			"markdown"
+		]
+	},
+	body: {
+		description: "The content of the note represented with Markdown",
+		type: "string",
+		maxLength: 1048576
+	},
+	updatedAt: {
+		description: "The date time when the note was last updated, represented with Unix timestamps in milliseconds",
+		type: "number"
+	},
+	createdAt: {
+		description: "The date time when the note was created, represented with Unix timestamps in milliseconds",
+		type: "number"
+	},
+	tags: {
+		description: "The list of tag IDs",
+		type: "array",
+		items: {
+			type: "string"
+		},
+		uniqueItems: true
+	},
+	numOfTasks: {
+		description: "The number of tasks, extracted from body",
+		type: "number"
+	},
+	numOfCheckedTasks: {
+		description: "The number of checked tasks, extracted from body",
+		type: "number"
+	},
+	migratedBy: {
+		description: "The type of the data migration",
+		type: "string",
+		maxLength: 128
+	},
+	status: {
+		description: "The status of the note",
+		type: "string",
+		"enum": [
+			"none",
+			"active",
+			"onHold",
+			"completed",
+			"dropped"
+		]
+	},
+	share: {
+		description: "The sharing mode of the note",
+		type: "string",
+		"enum": [
+			"private",
+			"public"
+		]
+	},
+	pinned: {
+		description: "Whether the note is pinned to top",
+		type: "boolean"
+	},
+	_conflicts: {
+		description: "Conflicted revisions",
+		type: "array",
+		items: {
+			type: "string"
+		},
+		uniqueItems: true
+	}
+};
+var required$3 = [
+	"_id",
+	"bookId",
+	"title",
+	"doctype",
+	"body",
+	"updatedAt",
+	"createdAt"
+];
+var note = {
+	$schema: $schema$3,
+	$id: $id$3,
+	title: title$3,
+	description: description$3,
+	type: type$3,
+	properties: properties$3,
+	required: required$3
+};
+
+var TRASH_BOOK_ID = 'trash';
+var NOTE_STATUS = {
+    NONE: 'none',
+    ACTIVE: 'active',
+    ON_HOLD: 'onHold',
+    COMPLETED: 'completed',
+    DROPPED: 'dropped'
+};
+var NOTE_VISIBILITY = {
+    PRIVATE: 'private',
+    PUBLIC: 'public'
+};
 var validateNote = validator;
 
+var $schema$2 = "http://json-schema.org/draft-07/schema#";
+var $id$2 = "book";
+var title$2 = "Book";
+var description$2 = "A notebook data";
+var type$2 = "object";
+var properties$2 = {
+	_id: {
+		description: "The unique notebook ID which should start with `book:` and the remains are randomly generated string",
+		type: "string",
+		minLength: 6,
+		maxLength: 128,
+		pattern: "^book:"
+	},
+	_rev: {
+		description: "This is a CouchDB specific field. The current MVCC-token/revision of this document (mandatory and immutable)",
+		type: "string"
+	},
+	name: {
+		description: "The notebook name",
+		type: "string",
+		minLength: 1,
+		maxLength: 64
+	},
+	updatedAt: {
+		description: "The date time when the notebook was last updated, represented with Unix timestamps in milliseconds",
+		type: "number"
+	},
+	createdAt: {
+		description: "The date time when the notebook was created, represented with Unix timestamps in milliseconds",
+		type: "number"
+	},
+	count: {
+		description: "It indicates the number of notes in the notebook",
+		type: "number"
+	},
+	parentBookId: {
+		description: "The ID of the parent notebook",
+		type: [
+			"string",
+			"null"
+		]
+	}
+};
+var required$2 = [
+	"_id",
+	"name",
+	"updatedAt",
+	"createdAt"
+];
+var book = {
+	$schema: $schema$2,
+	$id: $id$2,
+	title: title$2,
+	description: description$2,
+	type: type$2,
+	properties: properties$2,
+	required: required$2
+};
+
 var validateBook = validator$1;
 
-var TAG_COLOR = {
-    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'
-};
+var $schema$1 = "http://json-schema.org/draft-07/schema#";
+var $id$1 = "tag";
+var title$1 = "Tag";
+var description$1 = "A note tag";
+var type$1 = "object";
+var properties$1 = {
+	_id: {
+		description: "The unique tag ID which should start with `tag:` and the remains are randomly generated string",
+		type: "string",
+		minLength: 6,
+		maxLength: 128,
+		pattern: "^tag:"
+	},
+	_rev: {
+		description: "This is a CouchDB specific field. The current MVCC-token/revision of this document (mandatory and immutable)",
+		type: "string"
+	},
+	name: {
+		description: "The name of the tag",
+		type: "string",
+		maxLength: 64
+	},
+	count: {
+		description: "It indicates the number of notes with the tag",
+		type: "number"
+	},
+	color: {
+		description: "The color type of the tag",
+		type: "string",
+		"enum": [
+			"default",
+			"red",
+			"orange",
+			"yellow",
+			"olive",
+			"green",
+			"teal",
+			"blue",
+			"violet",
+			"purple",
+			"pink",
+			"brown",
+			"grey",
+			"black"
+		]
+	},
+	updatedAt: {
+		description: "The date time when the tag was last updated, represented with Unix timestamps in milliseconds",
+		type: "number"
+	},
+	createdAt: {
+		description: "The date time when the tag was created, represented with Unix timestamps in milliseconds",
+		type: "number"
+	}
+};
+var required$1 = [
+	"_id",
+	"name",
+	"count",
+	"updatedAt",
+	"createdAt"
+];
+var tag = {
+	$schema: $schema$1,
+	$id: $id$1,
+	title: title$1,
+	description: description$1,
+	type: type$1,
+	properties: properties$1,
+	required: required$1
+};
+
+var TAG_COLOR = {
+    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'
+};
 var validateTag = validator$2;
 
-/*! *****************************************************************************
+/******************************************************************************
 Copyright (c) Microsoft Corporation.
 
 Permission to use, copy, modify, and/or distribute this software for any
@@ -83,49 +331,162 @@ var __assign = function() {
     return __assign.apply(this, arguments);
 };
 
-var supportedImageFileTypes = [
-    'image/png',
-    'image/jpeg',
-    'image/jpg',
-    'image/svg+xml',
-    'image/gif',
-    'image/heic',
-    'image/heif'
-];
-var SUPPORTED_IMAGE_MIME_TYPES = __assign(__assign({}, supportedImageFileTypes.reduce(function (hash, ft) {
-    var _a;
-    return (__assign(__assign({}, hash), (_a = {}, _a[ft.split('/')[1]] = ft, _a)));
-}, {})), { jpg: 'image/jpeg' });
-var maxAttachmentFileSize = 10 * 1024 * 1024;
+var $schema = "http://json-schema.org/draft-07/schema#";
+var $id = "file";
+var title = "File";
+var description = "An attachment file";
+var type = "object";
+var properties = {
+	_id: {
+		description: "The unique document ID which should start with `file:` and the remains are randomly generated string",
+		type: "string",
+		minLength: 6,
+		maxLength: 128,
+		pattern: "^file:"
+	},
+	_rev: {
+		description: "This is a CouchDB specific field. The current MVCC-token/revision of this document (mandatory and immutable).",
+		type: "string"
+	},
+	name: {
+		description: "The file name",
+		type: "string",
+		minLength: 1,
+		maxLength: 128
+	},
+	createdAt: {
+		description: "The date time when the note was created, represented with Unix timestamps in milliseconds",
+		type: "number"
+	},
+	contentType: {
+		description: "The MIME type of the content",
+		type: "string",
+		"enum": [
+			"image/png",
+			"image/jpeg",
+			"image/jpg",
+			"image/svg+xml",
+			"image/gif",
+			"image/heic",
+			"image/heif"
+		],
+		maxLength: 128
+	},
+	contentLength: {
+		description: "The content length of the file",
+		type: "number",
+		maximum: 10485760
+	},
+	publicIn: {
+		description: "An array of the note IDs where the file is included",
+		type: "array",
+		items: {
+			type: "string"
+		},
+		uniqueItems: true
+	},
+	_attachments: {
+		description: "The attachment file",
+		type: "object",
+		properties: {
+			index: {
+				description: "The attachment file",
+				type: "object",
+				properties: {
+					content_type: {
+						description: "The content type of the file",
+						type: "string",
+						"enum": [
+							"image/png",
+							"image/jpeg",
+							"image/jpg",
+							"image/svg+xml",
+							"image/gif",
+							"image/heic",
+							"image/heif"
+						]
+					},
+					data: {
+						description: "The file data",
+						type: [
+							"string",
+							"object"
+						]
+					}
+				},
+				required: [
+					"content_type",
+					"data"
+				]
+			}
+		},
+		required: [
+			"index"
+		]
+	}
+};
+var required = [
+	"_id",
+	"name",
+	"createdAt",
+	"contentType",
+	"contentLength",
+	"publicIn",
+	"_attachments"
+];
+var file = {
+	$schema: $schema,
+	$id: $id,
+	title: title,
+	description: description,
+	type: type,
+	properties: properties,
+	required: required
+};
+
+var supportedImageFileTypes = [
+    'image/png',
+    'image/jpeg',
+    'image/jpg',
+    'image/svg+xml',
+    'image/gif',
+    'image/heic',
+    'image/heif'
+];
+var SUPPORTED_IMAGE_MIME_TYPES = __assign(__assign({}, supportedImageFileTypes.reduce(function (hash, ft) {
+    var _a;
+    return (__assign(__assign({}, hash), (_a = {}, _a[ft.split('/')[1]] = ft, _a)));
+}, {})), { jpg: 'image/jpeg' });
+var maxAttachmentFileSize = 10 * 1024 * 1024;
 var validateFile = validator$3;
 
-function validationErrorsToMessage(errors) {
-    if (errors instanceof Array) {
-        return errors
-            .map(function (e) {
-            if (typeof e === 'object') {
-                return "\"".concat(e.instancePath, "\" ").concat(e.message);
-            }
-            else {
-                return e;
-            }
-        })
-            .join(', ');
-    }
-    else {
-        return errors;
-    }
-}
-var InvalidDataError = /** @class */ (function (_super) {
-    __extends(InvalidDataError, _super);
-    function InvalidDataError(message, errors) {
-        var _this = _super.call(this, message + ' ' + validationErrorsToMessage(errors)) || this;
-        _this.name = 'InvalidDataError';
-        _this.errors = errors;
-        return _this;
-    }
-    return InvalidDataError;
+function validationErrorsToMessage(errors) {
+    if (errors instanceof Array) {
+        return errors
+            .map(function (e) {
+            if (typeof e === 'object') {
+                return "\"".concat(e.instancePath, "\" ").concat(e.message);
+            }
+            else {
+                return e;
+            }
+        })
+            .join(', ');
+    }
+    else {
+        return errors;
+    }
+}
+var InvalidDataError = /** @class */ (function (_super) {
+    __extends(InvalidDataError, _super);
+    function InvalidDataError(message, errors) {
+        var _this = _super.call(this, message + ' ' + validationErrorsToMessage(errors)) || this;
+        _this.name = 'InvalidDataError';
+        _this.errors = errors;
+        return _this;
+    }
+    return InvalidDataError;
 }(Error));
 
-export { InvalidDataError, NOTE_STATUS, NOTE_VISIBILITY, SUPPORTED_IMAGE_MIME_TYPES, TAG_COLOR, TRASH_BOOK_ID, maxAttachmentFileSize, supportedImageFileTypes, validateBook, validateFile, validateNote, validateTag, validationErrorsToMessage };
+export { book as BookSchema, file as FileSchema, InvalidDataError, NOTE_STATUS, NOTE_VISIBILITY, note as NoteSchema, SUPPORTED_IMAGE_MIME_TYPES, TAG_COLOR, TRASH_BOOK_ID, tag as TagSchema, maxAttachmentFileSize, supportedImageFileTypes, validateBook, validateFile, validateNote, validateTag, validationErrorsToMessage };
 //# sourceMappingURL=index.esm.js.map