@sebbo2002/vestaboard 4.0.2-develop.9 → 5.0.0

package/dist/index.d.cts

@@ -1,27 +1,108 @@
+/**
+ * You can build a message like this:
+ *
+ * ```javascript
+ * import { Message } from '@sebbo2002/vestaboard';
+ *
+ * const myMessage = new Message('Hello World');
+ *
+ * // same as
+ *
+ * const myOtherMessage = new Message()
+ *     .write('Hello World')
+ *     .center();
+ * ```
+ */
+declare class Message {
+    private static readonly splitter;
+    get isEmpty(): boolean;
+    private readonly board;
+    private cursor;
+    constructor(message?: BoardCharArray | string);
+    static char2char(char: string): number[];
+    static charToString(char: number): string;
+    static getColumnSizesFromData(rows: Array<string[]>, options?: MessageWriteOptions): number[];
+    static removeEmojisFromChars(chars: number[]): number[];
+    static splitCharsIntoLines(chars: number[], lineLength: [number, number]): Array<number[]>;
+    static string2chars(word: string, options?: MessageWriteOptions): number[];
+    /**
+     * Center the current message content
+     */
+    center(): void;
+    /**
+     * Fills the board with the passed character or text. The text
+     * is repeated again and again until the board is completely filled.
+     */
+    fill(text?: string): this;
+    /**
+     * Generate a table with the given data
+     *
+     * @example new Message().table([
+     *     ['now', 'Daily'],
+     *     ['13:00', 'Super Secret Meeting'],
+     *     ['16:30', 'Awesome Presentation']
+     * ])
+     *
+     * #==============================================#
+     * # N O W       D A I L Y                        #
+     * #                                              #
+     * # 1 3 : 0 0   S U P E R   S E C R E T          #
+     * #             M E E T I N G                    #
+     * #                                              #
+     * # 1 6 : 3 0   A W E S O M E   P R E S E N T -  #
+     * #==============================================#
+     */
+    table(rows: Array<string[]>): this;
+    toCharArray(): BoardCharArray;
+    toString(): string;
+    /**
+     * Write a text on your new message. If your message is not empty it will continue
+     * where you last left off (`position: MessageWritePosition.CURRENT`). Alternatively
+     * you can continue on the next line or give an exact position.
+     *
+     * @param text
+     * @param options
+     */
+    write(text: string, options?: MessageWriteOptions): this;
+}
+
+declare class ReadWriteAPI {
+    private readonly key;
+    private readonly options;
+    constructor(key: string, options?: RequestOptions);
+    getCurrentMessage(): Promise<Message>;
+    postMessage(message: Message | string): Promise<void>;
+    private request;
+}
+
 declare class SubscriptionAPI {
     private readonly key;
-    private readonly secret;
     private readonly options;
+    private readonly secret;
     constructor(key: string, secret: string, options?: RequestOptions);
-    private request;
-    getViewer(): Promise<Viewer>;
     getSubscriptions(): Promise<Subscriptions>;
+    getViewer(): Promise<Viewer>;
     postMessage(message: Message | string): Promise<SubscriptionPostResponse[]>;
     postMessage(message: Message | string, subscriptionId: string): Promise<SubscriptionPostResponse>;
     postMessage(message: Message | string, subscriptionIds: string[]): Promise<SubscriptionPostResponse[]>;
-}
-
-declare class ReadWriteAPI {
-    private readonly key;
-    private readonly options;
-    constructor(key: string, options?: RequestOptions);
     private request;
-    getCurrentMessage(): Promise<Message>;
-    postMessage(message: Message | string): Promise<void>;
 }
 
 declare const BOARD_LINE_LENGTH = 22;
 declare const BOARD_LINES = 6;
+declare enum MessageWritePosition {
+    CURRENT = 0,
+    NO_SPACE_BETWEEN = 1,
+    NEXT_LINE = 2
+}
+type BoardCharArray = [
+    BoardCharLine,
+    BoardCharLine,
+    BoardCharLine,
+    BoardCharLine,
+    BoardCharLine,
+    BoardCharLine
+];
 type BoardCharLine = [
     number,
     number,
@@ -46,28 +127,22 @@ type BoardCharLine = [
     number,
     number
 ];
-type BoardCharArray = [
-    BoardCharLine,
-    BoardCharLine,
-    BoardCharLine,
-    BoardCharLine,
-    BoardCharLine,
-    BoardCharLine
-];
+type Boards = Array<LocalAPI | ReadWriteAPI | SubscriptionAPI>;
+interface Installation {
+    _id: string;
+    installable?: {
+        _id: string;
+    };
+}
 interface MessageWriteCoords {
     line: number;
     row?: number;
     width?: number;
 }
-declare enum MessageWritePosition {
-    CURRENT = 0,
-    NO_SPACE_BETWEEN = 1,
-    NEXT_LINE = 2
-}
 interface MessageWriteOptions {
-    position?: MessageWriteCoords | MessageWritePosition;
+    fallbackChar?: null | number;
     indent?: boolean | number;
-    fallbackChar?: number | null;
+    position?: MessageWriteCoords | MessageWritePosition;
     removeUnsupportedWords?: boolean;
 }
 interface RequestFetchOptions {
@@ -76,132 +151,57 @@ interface RequestFetchOptions {
     method?: string;
 }
 interface RequestFetchResponse {
+    json(): Promise<unknown>;
     readonly ok: boolean;
     readonly status: number;
     readonly statusText: string;
-    json(): Promise<unknown>;
 }
-type RequestOptionsFetch = (url: string, init?: RequestFetchOptions) => Promise<RequestFetchResponse>;
 interface RequestOptions {
     fetch?: RequestOptionsFetch;
     parseResponse?: boolean;
 }
-interface Installation {
-    _id: string;
-    installable?: {
-        _id: string;
-    };
-}
-interface Viewer {
-    type: string;
-    _id: string;
-    _created: string;
-    installation: {
-        _id: string;
-    };
-}
+type RequestOptionsFetch = (url: string, init?: RequestFetchOptions) => Promise<RequestFetchResponse>;
 interface Subscription {
-    _id: string;
     _created: string;
-    installation: Installation;
+    _id: string;
     boards: Array<{
         _id: string;
     }>;
-}
-interface Subscriptions {
-    subscriptions: Subscription[];
+    installation: Installation;
 }
 interface SubscriptionPostResponse {
     message: {
-        id: string;
         created: number;
+        id: string;
     };
 }
-type Boards = Array<LocalAPI | ReadWriteAPI | SubscriptionAPI>;
-
-/**
- * You can build a message like this:
- *
- * ```javascript
- * import { Message } from '@sebbo2002/vestaboard';
- *
- * const myMessage = new Message('Hello World');
- *
- * // same as
- *
- * const myOtherMessage = new Message()
- *     .write('Hello World')
- *     .center();
- * ```
- */
-declare class Message {
-    private static readonly splitter;
-    private readonly board;
-    private cursor;
-    constructor(message?: BoardCharArray | string);
-    static string2chars(word: string, options?: MessageWriteOptions): number[];
-    static char2char(char: string): number[];
-    static charToString(char: number): string;
-    static splitCharsIntoLines(chars: number[], lineLength: [number, number]): Array<number[]>;
-    static removeEmojisFromChars(chars: number[]): number[];
-    static getColumnSizesFromData(rows: Array<string[]>, options?: MessageWriteOptions): number[];
-    get isEmpty(): boolean;
-    /**
-     * Fills the board with the passed character or text. The text
-     * is repeated again and again until the board is completely filled.
-     */
-    fill(text?: string): this;
-    /**
-     * Write a text on your new message. If your message is not empty it will continue
-     * where you last left off (`position: MessageWritePosition.CURRENT`). Alternatively
-     * you can continue on the next line or give an exact position.
-     *
-     * @param text
-     * @param options
-     */
-    write(text: string, options?: MessageWriteOptions): this;
-    /**
-     * Generate a table with the given data
-     *
-     * @example new Message().table([
-     *     ['now', 'Daily'],
-     *     ['13:00', 'Super Secret Meeting'],
-     *     ['16:30', 'Awesome Presentation']
-     * ])
-     *
-     * #==============================================#
-     * # N O W       D A I L Y                        #
-     * #                                              #
-     * # 1 3 : 0 0   S U P E R   S E C R E T          #
-     * #             M E E T I N G                    #
-     * #                                              #
-     * # 1 6 : 3 0   A W E S O M E   P R E S E N T -  #
-     * #==============================================#
-     */
-    table(rows: Array<string[]>): this;
-    /**
-     * Center the current message content
-     */
-    center(): void;
-    toString(): string;
-    toCharArray(): BoardCharArray;
+interface Subscriptions {
+    subscriptions: Subscription[];
+}
+interface Viewer {
+    _created: string;
+    _id: string;
+    installation: {
+        _id: string;
+    };
+    type: string;
 }
 
 declare class LocalAPI {
-    private readonly key;
     private readonly host;
+    private readonly key;
     private readonly options;
     constructor(key: string, host?: string, options?: RequestOptions);
-    private request;
     getCurrentMessage(): Promise<Message>;
     postMessage(message: Message | string): Promise<void>;
+    private request;
 }
 
 declare class MultipleBoards {
     private readonly boards;
     constructor(boards?: Boards);
-    push(...boards: Boards): void;
     postMessage(message: Message | string): Promise<void>;
+    push(...boards: Boards): void;
 }
 
 export { BOARD_LINES, BOARD_LINE_LENGTH, type BoardCharArray, type BoardCharLine, type Boards, type Installation, LocalAPI, Message, type MessageWriteCoords, type MessageWriteOptions, MessageWritePosition, MultipleBoards, ReadWriteAPI, type RequestOptions, type Subscription, SubscriptionAPI, type SubscriptionPostResponse, type Subscriptions, type Viewer };

package/dist/index.d.ts

@@ -1,27 +1,108 @@
+/**
+ * You can build a message like this:
+ *
+ * ```javascript
+ * import { Message } from '@sebbo2002/vestaboard';
+ *
+ * const myMessage = new Message('Hello World');
+ *
+ * // same as
+ *
+ * const myOtherMessage = new Message()
+ *     .write('Hello World')
+ *     .center();
+ * ```
+ */
+declare class Message {
+    private static readonly splitter;
+    get isEmpty(): boolean;
+    private readonly board;
+    private cursor;
+    constructor(message?: BoardCharArray | string);
+    static char2char(char: string): number[];
+    static charToString(char: number): string;
+    static getColumnSizesFromData(rows: Array<string[]>, options?: MessageWriteOptions): number[];
+    static removeEmojisFromChars(chars: number[]): number[];
+    static splitCharsIntoLines(chars: number[], lineLength: [number, number]): Array<number[]>;
+    static string2chars(word: string, options?: MessageWriteOptions): number[];
+    /**
+     * Center the current message content
+     */
+    center(): void;
+    /**
+     * Fills the board with the passed character or text. The text
+     * is repeated again and again until the board is completely filled.
+     */
+    fill(text?: string): this;
+    /**
+     * Generate a table with the given data
+     *
+     * @example new Message().table([
+     *     ['now', 'Daily'],
+     *     ['13:00', 'Super Secret Meeting'],
+     *     ['16:30', 'Awesome Presentation']
+     * ])
+     *
+     * #==============================================#
+     * # N O W       D A I L Y                        #
+     * #                                              #
+     * # 1 3 : 0 0   S U P E R   S E C R E T          #
+     * #             M E E T I N G                    #
+     * #                                              #
+     * # 1 6 : 3 0   A W E S O M E   P R E S E N T -  #
+     * #==============================================#
+     */
+    table(rows: Array<string[]>): this;
+    toCharArray(): BoardCharArray;
+    toString(): string;
+    /**
+     * Write a text on your new message. If your message is not empty it will continue
+     * where you last left off (`position: MessageWritePosition.CURRENT`). Alternatively
+     * you can continue on the next line or give an exact position.
+     *
+     * @param text
+     * @param options
+     */
+    write(text: string, options?: MessageWriteOptions): this;
+}
+
+declare class ReadWriteAPI {
+    private readonly key;
+    private readonly options;
+    constructor(key: string, options?: RequestOptions);
+    getCurrentMessage(): Promise<Message>;
+    postMessage(message: Message | string): Promise<void>;
+    private request;
+}
+
 declare class SubscriptionAPI {
     private readonly key;
-    private readonly secret;
     private readonly options;
+    private readonly secret;
     constructor(key: string, secret: string, options?: RequestOptions);
-    private request;
-    getViewer(): Promise<Viewer>;
     getSubscriptions(): Promise<Subscriptions>;
+    getViewer(): Promise<Viewer>;
     postMessage(message: Message | string): Promise<SubscriptionPostResponse[]>;
     postMessage(message: Message | string, subscriptionId: string): Promise<SubscriptionPostResponse>;
     postMessage(message: Message | string, subscriptionIds: string[]): Promise<SubscriptionPostResponse[]>;
-}
-
-declare class ReadWriteAPI {
-    private readonly key;
-    private readonly options;
-    constructor(key: string, options?: RequestOptions);
     private request;
-    getCurrentMessage(): Promise<Message>;
-    postMessage(message: Message | string): Promise<void>;
 }
 
 declare const BOARD_LINE_LENGTH = 22;
 declare const BOARD_LINES = 6;
+declare enum MessageWritePosition {
+    CURRENT = 0,
+    NO_SPACE_BETWEEN = 1,
+    NEXT_LINE = 2
+}
+type BoardCharArray = [
+    BoardCharLine,
+    BoardCharLine,
+    BoardCharLine,
+    BoardCharLine,
+    BoardCharLine,
+    BoardCharLine
+];
 type BoardCharLine = [
     number,
     number,
@@ -46,28 +127,22 @@ type BoardCharLine = [
     number,
     number
 ];
-type BoardCharArray = [
-    BoardCharLine,
-    BoardCharLine,
-    BoardCharLine,
-    BoardCharLine,
-    BoardCharLine,
-    BoardCharLine
-];
+type Boards = Array<LocalAPI | ReadWriteAPI | SubscriptionAPI>;
+interface Installation {
+    _id: string;
+    installable?: {
+        _id: string;
+    };
+}
 interface MessageWriteCoords {
     line: number;
     row?: number;
     width?: number;
 }
-declare enum MessageWritePosition {
-    CURRENT = 0,
-    NO_SPACE_BETWEEN = 1,
-    NEXT_LINE = 2
-}
 interface MessageWriteOptions {
-    position?: MessageWriteCoords | MessageWritePosition;
+    fallbackChar?: null | number;
     indent?: boolean | number;
-    fallbackChar?: number | null;
+    position?: MessageWriteCoords | MessageWritePosition;
     removeUnsupportedWords?: boolean;
 }
 interface RequestFetchOptions {
@@ -76,132 +151,57 @@ interface RequestFetchOptions {
     method?: string;
 }
 interface RequestFetchResponse {
+    json(): Promise<unknown>;
     readonly ok: boolean;
     readonly status: number;
     readonly statusText: string;
-    json(): Promise<unknown>;
 }
-type RequestOptionsFetch = (url: string, init?: RequestFetchOptions) => Promise<RequestFetchResponse>;
 interface RequestOptions {
     fetch?: RequestOptionsFetch;
     parseResponse?: boolean;
 }
-interface Installation {
-    _id: string;
-    installable?: {
-        _id: string;
-    };
-}
-interface Viewer {
-    type: string;
-    _id: string;
-    _created: string;
-    installation: {
-        _id: string;
-    };
-}
+type RequestOptionsFetch = (url: string, init?: RequestFetchOptions) => Promise<RequestFetchResponse>;
 interface Subscription {
-    _id: string;
     _created: string;
-    installation: Installation;
+    _id: string;
     boards: Array<{
         _id: string;
     }>;
-}
-interface Subscriptions {
-    subscriptions: Subscription[];
+    installation: Installation;
 }
 interface SubscriptionPostResponse {
     message: {
-        id: string;
         created: number;
+        id: string;
     };
 }
-type Boards = Array<LocalAPI | ReadWriteAPI | SubscriptionAPI>;
-
-/**
- * You can build a message like this:
- *
- * ```javascript
- * import { Message } from '@sebbo2002/vestaboard';
- *
- * const myMessage = new Message('Hello World');
- *
- * // same as
- *
- * const myOtherMessage = new Message()
- *     .write('Hello World')
- *     .center();
- * ```
- */
-declare class Message {
-    private static readonly splitter;
-    private readonly board;
-    private cursor;
-    constructor(message?: BoardCharArray | string);
-    static string2chars(word: string, options?: MessageWriteOptions): number[];
-    static char2char(char: string): number[];
-    static charToString(char: number): string;
-    static splitCharsIntoLines(chars: number[], lineLength: [number, number]): Array<number[]>;
-    static removeEmojisFromChars(chars: number[]): number[];
-    static getColumnSizesFromData(rows: Array<string[]>, options?: MessageWriteOptions): number[];
-    get isEmpty(): boolean;
-    /**
-     * Fills the board with the passed character or text. The text
-     * is repeated again and again until the board is completely filled.
-     */
-    fill(text?: string): this;
-    /**
-     * Write a text on your new message. If your message is not empty it will continue
-     * where you last left off (`position: MessageWritePosition.CURRENT`). Alternatively
-     * you can continue on the next line or give an exact position.
-     *
-     * @param text
-     * @param options
-     */
-    write(text: string, options?: MessageWriteOptions): this;
-    /**
-     * Generate a table with the given data
-     *
-     * @example new Message().table([
-     *     ['now', 'Daily'],
-     *     ['13:00', 'Super Secret Meeting'],
-     *     ['16:30', 'Awesome Presentation']
-     * ])
-     *
-     * #==============================================#
-     * # N O W       D A I L Y                        #
-     * #                                              #
-     * # 1 3 : 0 0   S U P E R   S E C R E T          #
-     * #             M E E T I N G                    #
-     * #                                              #
-     * # 1 6 : 3 0   A W E S O M E   P R E S E N T -  #
-     * #==============================================#
-     */
-    table(rows: Array<string[]>): this;
-    /**
-     * Center the current message content
-     */
-    center(): void;
-    toString(): string;
-    toCharArray(): BoardCharArray;
+interface Subscriptions {
+    subscriptions: Subscription[];
+}
+interface Viewer {
+    _created: string;
+    _id: string;
+    installation: {
+        _id: string;
+    };
+    type: string;
 }
 
 declare class LocalAPI {
-    private readonly key;
     private readonly host;
+    private readonly key;
     private readonly options;
     constructor(key: string, host?: string, options?: RequestOptions);
-    private request;
     getCurrentMessage(): Promise<Message>;
     postMessage(message: Message | string): Promise<void>;
+    private request;
 }
 
 declare class MultipleBoards {
     private readonly boards;
     constructor(boards?: Boards);
-    push(...boards: Boards): void;
     postMessage(message: Message | string): Promise<void>;
+    push(...boards: Boards): void;
 }
 
 export { BOARD_LINES, BOARD_LINE_LENGTH, type BoardCharArray, type BoardCharLine, type Boards, type Installation, LocalAPI, Message, type MessageWriteCoords, type MessageWriteOptions, MessageWritePosition, MultipleBoards, ReadWriteAPI, type RequestOptions, type Subscription, SubscriptionAPI, type SubscriptionPostResponse, type Subscriptions, type Viewer };