diff --git a/jsr.json b/jsr.json index 2295d35..f0e2358 100644 --- a/jsr.json +++ b/jsr.json @@ -1,5 +1,5 @@ { "name": "@cardboard-ink/cardboard-js", - "version": "1.0.5", + "version": "1.0.6", "exports": "./src/index.ts" } diff --git a/package.json b/package.json index 4cf70e2..cbfa6e9 100644 --- a/package.json +++ b/package.json @@ -1,6 +1,6 @@ { "name": "cardboard.js", - "version": "1.0.5", + "version": "1.0.6", "description": "JS/TS Wrapper for the CardBoard API", "main": "dist/index.js", "types": "dist/index.d.ts", diff --git a/src/types.ts b/src/types.ts index 32b188c..23eb418 100644 --- a/src/types.ts +++ b/src/types.ts @@ -167,11 +167,24 @@ export interface UserStatus { customReaction?: CustomReaction } +/** + * @typedef {Object} Content + * @property {string} object + * @property {Document} document + * Slate helper object for easy navigation + */ export interface Content { object: string document: Document } +/** + * @typedef {Object} Document + * @property {Data} data + * @property {Node[]} nodes + * @property {string} object + * Slate helper object for easy navigation + */ export interface Document { data: Data nodes: Node[] @@ -180,6 +193,14 @@ export interface Document { export interface Data {} +/** + * @typedef {Object} Node + * @property {Data2} data + * @property {string} type + * @property {Node2[]} nodes + * @property {string} object + * Slate helper object for easy navigation + */ export interface Node { data: Data2 type: string @@ -189,11 +210,24 @@ export interface Node { export interface Data2 {} +/** + * @typedef {Object} Node2 + * @property {Lefe[]} leaves + * @property {string} object + * Slate helper object for easy navigation + */ export interface Node2 { leaves: Lefe[] object: string } +/** + * @typedef {Object} Lefe + * @property {string} text + * @property {any[]} marks + * @property {string} object + * Slate helper object for easy navigation + */ export interface Lefe { text: string marks: any[]