Add types and give better names

Author: jcbrand

src/headless/plugins/chatboxes/chatboxes.js

@@ -43,14 +43,14 @@ class ChatBoxes extends Collection {
         const bare_jid = _converse.session.get('bare_jid');
         initStorage(this, `converse.chatboxes-${bare_jid}`);
         this.fetch({
-            'add': true,
-            'success': (c) => this.onChatBoxesFetched(c),
+            add: true,
+            success: (c) => this.onChatBoxesFetched(c),
         });
     }
 
     /**
-     * @param {object} attrs
-     * @param {object} options
+     * @param {import('./types').CreateModelAttributes} attrs
+     * @param {import('@converse/skeletor/src/types/model.js').ModelOptions} options
      */
     createModel(attrs, options) {
         if (!attrs.type) {

src/headless/plugins/chatboxes/types.ts

@@ -0,0 +1,3 @@
+export type CreateModelAttributes = Record<string, string> & {
+    type: string;
+}

src/headless/types/plugins/chatboxes/chatboxes.d.ts

@@ -17,10 +17,10 @@ declare class ChatBoxes extends Collection {
      */
     onConnected(reconnecting: boolean): void;
     /**
-     * @param {object} attrs
-     * @param {object} options
+     * @param {import('./types').CreateModelAttributes} attrs
+     * @param {import('@converse/skeletor/src/types/model.js').ModelOptions} options
      */
-    createModel(attrs: object, options: object): any;
+    createModel(attrs: import("./types").CreateModelAttributes, options: import("@converse/skeletor/src/types/model.js").ModelOptions): any;
 }
 import { Collection } from '@converse/skeletor';
 //# sourceMappingURL=chatboxes.d.ts.map

src/headless/types/plugins/chatboxes/types.d.ts

@@ -0,0 +1,4 @@
+export type CreateModelAttributes = Record<string, string> & {
+    type: string;
+};
+//# sourceMappingURL=types.d.ts.map

src/headless/types/utils/index.d.ts

@@ -43,9 +43,9 @@ declare const _default: {
     firstCharToUpperCase(text: string): string;
     getLongestSubstring(string: string, candidates: string[]): string;
     isString(s: any): boolean;
-    getDefaultStore(): "session" | "persistent";
-    createStore(id: any, store: any): any;
-    initStorage(model: any, id: any, type: any): void;
+    getDefaultStorageType(): import("./types.js").StorageType;
+    createStore(id: string, type: import("./types.js").StorageType): any;
+    initStorage(model: import("@converse/skeletor").Model | import("@converse/skeletor").Collection, id: string, type?: import("./types.js").StorageType): void;
     isErrorStanza(stanza: Element): boolean;
     isForbiddenError(stanza: Element): boolean;
     isServiceUnavailableError(stanza: Element): boolean;
@@ -129,8 +129,8 @@ declare function shouldCreateMessage(attrs: any): any;
  * @param {boolean} [cancelable]
  */
 declare function triggerEvent(el: Element, name: string, type?: string, bubbles?: boolean, cancelable?: boolean): void;
+import { Model } from '@converse/skeletor';
 import * as session from './session.js';
 import * as promise from './promise.js';
-import { Model } from '@converse/skeletor';
 import * as init from './init.js';
 //# sourceMappingURL=index.d.ts.map

src/headless/types/utils/storage.d.ts

@@ -1,4 +1,16 @@
-export function getDefaultStore(): "session" | "persistent";
-export function createStore(id: any, store: any): any;
-export function initStorage(model: any, id: any, type: any): void;
+/**
+ * @returns {import('./types').StorageType}
+ */
+export function getDefaultStorageType(): import("./types").StorageType;
+/**
+ * @param {string} id
+ * @param {import('./types').StorageType} type
+ */
+export function createStore(id: string, type: import("./types").StorageType): any;
+/**
+ * @param {import('@converse/skeletor').Model|import('@converse/skeletor').Collection} model
+ * @param {string} id
+ * @param {import('./types').StorageType} [type]
+ */
+export function initStorage(model: import("@converse/skeletor").Model | import("@converse/skeletor").Collection, id: string, type?: import("./types").StorageType): void;
 //# sourceMappingURL=storage.d.ts.map

src/headless/types/utils/types.d.ts

@@ -22,4 +22,5 @@ export type MediaURLMetadata = MediaURLIndexes & {
     is_image?: boolean;
     is_video?: boolean;
 };
+export type StorageType = 'persistent' | 'session';
 //# sourceMappingURL=types.d.ts.map

src/headless/utils/storage.js

@@ -5,7 +5,10 @@ import { getUnloadEvent } from './session.js';
 
 const settings = settings_api;
 
-export function getDefaultStore() {
+/**
+ * @returns {import('./types').StorageType}
+ */
+export function getDefaultStorageType() {
     if (_converse.state.config.get('trusted')) {
         const is_non_persistent = settings.get('persistent_store') === 'sessionStorage';
         return is_non_persistent ? 'session' : 'persistent';
@@ -14,23 +17,35 @@ export function getDefaultStore() {
     }
 }
 
-function storeUsesIndexedDB(store) {
-    return store === 'persistent' && settings.get('persistent_store') === 'IndexedDB';
+/**
+ * @param {import('./types').StorageType} type
+ */
+function storeUsesIndexedDB(type) {
+    return type === 'persistent' && settings.get('persistent_store') === 'IndexedDB';
 }
 
-export function createStore(id, store) {
-    const name = store || getDefaultStore();
+/**
+ * @param {string} id
+ * @param {import('./types').StorageType} type
+ */
+export function createStore(id, type) {
+    const name = type || getDefaultStorageType();
     const s = _converse.storage[name];
     if (typeof s === 'undefined') {
         throw new TypeError(`createStore: Could not find store for ${id}`);
     }
-    return new Storage(id, s, storeUsesIndexedDB(store));
+    return new Storage(id, s, storeUsesIndexedDB(type));
 }
 
+/**
+ * @param {import('@converse/skeletor').Model|import('@converse/skeletor').Collection} model
+ * @param {string} id
+ * @param {import('./types').StorageType} [type]
+ */
 export function initStorage(model, id, type) {
-    const store = type || getDefaultStore();
-    model.browserStorage = createStore(id, store);
-    if (storeUsesIndexedDB(store)) {
+    type = type || getDefaultStorageType();
+    model.browserStorage = createStore(id, type);
+    if (storeUsesIndexedDB(type)) {
         const flush = () => model.browserStorage.flush();
         const unloadevent = getUnloadEvent();
         window.addEventListener(unloadevent, flush);

src/headless/utils/types.ts

@@ -25,3 +25,5 @@ export type MediaURLMetadata = MediaURLIndexes & {
     is_image?: boolean;
     is_video?: boolean;
 };
+
+export type StorageType = 'persistent' | 'session';

src/plugins/controlbox/tests/login.js

@@ -45,15 +45,15 @@ describe("The Login Form", function () {
         cbview.querySelector('input[name="password"]').value = 'secret';
 
         expect(_converse.config.get('trusted')).toBe(true);
-        expect(u.getDefaultStore()).toBe('persistent');
+        expect(u.getDefaultStorageType()).toBe('persistent');
         cbview.querySelector('button[type="submit"]').click();
         expect(_converse.config.get('trusted')).toBe(true);
-        expect(u.getDefaultStore()).toBe('persistent');
+        expect(u.getDefaultStorageType()).toBe('persistent');
 
         checkbox.click();
         cbview.querySelector('button[type="submit"]').click();
         expect(_converse.config.get('trusted')).toBe(false);
-        expect(u.getDefaultStore()).toBe('session');
+        expect(u.getDefaultStorageType()).toBe('session');
     }));
 
     it("checkbox can be set to false by default",
@@ -81,11 +81,11 @@ describe("The Login Form", function () {
 
         cbview.querySelector('button[type="submit"]').click();
         expect(_converse.config.get('trusted')).toBe(false);
-        expect(u.getDefaultStore()).toBe('session');
+        expect(u.getDefaultStorageType()).toBe('session');
 
         checkbox.click();
         cbview.querySelector('button[type="submit"]').click();
         expect(_converse.config.get('trusted')).toBe(true);
-        expect(u.getDefaultStore()).toBe('persistent');
+        expect(u.getDefaultStorageType()).toBe('persistent');
     }));
 });