@tak-ps/cloudtak 13.0.0 → 13.0.2

package/dist/types/plugin.d.ts

@@ -4,7 +4,7 @@ import type { Router, RouteRecordRaw } from 'vue-router';
 import type { Pinia } from 'pinia';
 import type { MenuItemConfig } from './src/stores/modules/menu.ts';
 import type { BottomBarItemConfig } from './src/stores/modules/bottombar.ts';
-import { type DBFeature } from './src/base/database.ts';
+import { type DBFeature } from './src/database.ts';
 import { type Observable } from 'rxjs';
 import mapgl from 'maplibre-gl';
 export type { MenuItemConfig };

package/dist/types/src/base/chatroom-chats.d.ts

@@ -1,4 +1,4 @@
-import type { DBChatroomChat } from './database.ts';
+import type { DBChatroomChat } from '../database.ts';
 import type Atlas from '../workers/atlas.ts';
 import type { Remote } from 'comlink';
 export default class ChatroomChats {

package/dist/types/src/base/chatroom.d.ts

@@ -1,4 +1,4 @@
-import type { DBChatroom } from './database.ts';
+import type { DBChatroom } from '../database.ts';
 import ChatroomChats from './chatroom-chats.ts';
 import { type Observable } from 'dexie';
 import type { ProfileChatroomList, ProfileChatList } from '../types.ts';

package/dist/types/src/base/contact.d.ts

@@ -1,14 +1,23 @@
 import { type Observable } from 'dexie';
-import type { Contact } from '../types.ts';
-export default class ContactManager {
+import type { Contact as TAKContact } from '../types.ts';
+import BaseInterface from './interface.ts';
+import type { BaseInterface_ListOptions, BaseInterface_FromOptions } from './interface.ts';
+export type Contact_ListOptions = BaseInterface_ListOptions & {
+    token?: string;
+    filter?: string;
+};
+export type Contact_FromOptions = BaseInterface_FromOptions & {
+    token?: string;
+};
+export default class ContactManager extends BaseInterface {
+    static readonly listCacheKey = "contact";
+    static count(): Promise<number>;
     static liveCount(): Observable<number>;
-    static liveList(filter?: string): Observable<Contact[]>;
-    static list(opts?: {
-        token?: string;
-        filter?: string;
-    }): Promise<Contact[]>;
-    static get(uid: string): Promise<Contact | undefined>;
-    static getByCallsign(callsign: string): Promise<Contact | undefined>;
-    static put(contact: Contact): Promise<void>;
-    static sync(token?: string): Promise<Contact[]>;
+    static liveList(): Observable<TAKContact[]>;
+    static list(opts?: Contact_ListOptions): Promise<TAKContact[]>;
+    static from(uid: string, opts?: Contact_FromOptions): Promise<TAKContact | undefined>;
+    static liveFrom(uid: string): Observable<TAKContact | undefined>;
+    static getByCallsign(callsign: string): Promise<TAKContact | undefined>;
+    static put(contact: TAKContact): Promise<void>;
+    static sync(token?: string): Promise<void>;
 }

package/dist/types/src/base/group.d.ts

@@ -20,7 +20,13 @@ export default class GroupManager {
         active?: boolean;
         direction?: string;
     }): Promise<GroupChannel[]>;
+    /**
+     * Get a single GroupChannel by name.
+     */
     static get(name: string): Promise<GroupChannel | undefined>;
+    /**
+     * Put one or more GroupChannels into the database.
+     */
     static put(channels: GroupChannel[] | GroupChannel): Promise<void>;
     static sync(token?: string): Promise<GroupChannel[]>;
     static update(channels: GroupChannel[], token?: string): Promise<GroupChannel[]>;

package/dist/types/src/base/icon.d.ts

@@ -1,4 +1,4 @@
-import { type DBIcon } from './database.ts';
+import { type DBIcon } from '../database.ts';
 export interface IconHydrateResult {
     /** Iconsets that were added or refreshed during the diff. */
     changed: string[];
@@ -10,6 +10,14 @@ export interface IconHydrateResult {
 export default class Icon {
     static has(icon: string): Promise<boolean>;
     static get(icon: string): Promise<DBIcon | undefined>;
+    /**
+     * Return all cached icons ordered by key.
+     */
+    static all(): Promise<DBIcon[]>;
+    /**
+     * Return all icons belonging to a given iconset uid, ordered by path.
+     */
+    static list(iconsetUid: string): Promise<DBIcon[]>;
     /**
      * Diff the server iconset list against Dexie and refetch icons for any
      * iconsets that are new or whose `version`/`updated` differs.
@@ -30,6 +38,7 @@ export default class Icon {
      */
     static addIconset(uid: string, opts: {
         token: string;
+        force?: boolean;
     }): Promise<boolean>;
     /**
      * Remove an iconset and all of its icons from Dexie. Returns true when

package/dist/types/src/base/iconset.d.ts

@@ -0,0 +1,20 @@
+import { type Observable } from 'dexie';
+import { type DBIconset } from '../database.ts';
+import BaseInterface from './interface.ts';
+import type { BaseInterface_ListOptions, BaseInterface_FromOptions } from './interface.ts';
+export type Iconset_ListOptions = BaseInterface_ListOptions & {
+    token?: string;
+};
+export default class IconsetManager extends BaseInterface {
+    static readonly listCacheKey = "iconset";
+    static count(): Promise<number>;
+    static liveCount(): Observable<number>;
+    /**
+     * Return all locally cached iconsets ordered by name.
+     */
+    static list(opts?: Iconset_ListOptions): Promise<DBIconset[]>;
+    static liveList(): Observable<DBIconset[]>;
+    static from(uid: string, opts?: BaseInterface_FromOptions): Promise<DBIconset | undefined>;
+    static liveFrom(uid: string): Observable<DBIconset | undefined>;
+    static sync(token?: string): Promise<void>;
+}

package/dist/types/src/base/interface.d.ts

@@ -0,0 +1,71 @@
+import type { Observable } from 'dexie';
+export interface BaseInterface_ListOptions {
+    sync?: boolean;
+}
+export interface BaseInterface_FromOptions {
+    sync?: boolean;
+}
+export default class BaseInterface {
+    /**
+     * A unique key used for caching the list of items in memory, the dexie cache database contains the key
+     * and the date/time when the value was last synced with the database. This allows the library to determine
+     * when to invalidate the cache and fetch fresh data from the database.
+     */
+    static readonly listCacheKey: string;
+    /**
+     * Returns the total number of items in the database
+     */
+    static count(): Promise<number>;
+    /**
+     * Returns the total number of items in the database and updates in real-time when the count changes
+     */
+    static liveCount(): Observable<number>;
+    /**
+     * Returns when the local cache was last populated for this manager.
+     */
+    static hydrated(): Promise<Date | null>;
+    /**
+     * Returns a list of all items in the database
+     *
+     * If the sync option is set to true, the method will first trigger a sync to update the local database with the latest data from the server before returning the list of items.
+     */
+    static list(opts?: BaseInterface_ListOptions): Promise<unknown[]>;
+    /**
+     * Returns a list of all items in the database and updates in real-time when the list changes
+     */
+    static liveList(): Observable<unknown[]>;
+    /**
+     * Trigger a sync to update the local database with the latest data from the server
+     */
+    static sync(): Promise<void>;
+    /**
+     * Returns a single item from the database by its unique identifier
+     *
+     * @param id - The unique identifier of the item to retrieve
+     * @param opts - Optional parameters for fetching the item, such as whether to trigger a sync before fetching
+     */
+    static from(id: string, opts?: BaseInterface_FromOptions): Promise<unknown>;
+    /**
+     * Returns a single item from the database by its unique identifier and updates in real-time when the item changes
+     *
+     * @param id - The unique identifier of the item to retrieve
+     */
+    static liveFrom(id: string): Observable<unknown>;
+    /**
+     * Generates a new item, attempt to save it via the API and save it to the database
+     */
+    static generate(): Promise<unknown>;
+    /**
+     * Updates an item in the database by its unique identifier and attempts to update it via the API
+     *
+     * @param id - The unique identifier of the item to update
+     * @param data - The data to update the item with
+     */
+    static update(): Promise<void>;
+    /**
+     * Deletes an item from the database by its unique identifier and attempts to delete it via the API
+     *
+     * @param id - The unique identifier of the item to delete
+     */
+    static delete(id: string): Promise<void>;
+}

package/dist/types/src/base/mission-template-logs.d.ts

@@ -1,4 +1,4 @@
-import type { DBMissionTemplateLog } from './database.ts';
+import type { DBMissionTemplateLog } from '../database.ts';
 export default class MissionTemplateLogs {
     template: string;
     constructor(template: string);

package/dist/types/src/base/mission-template.d.ts

@@ -1,4 +1,4 @@
-import type { DBMissionTemplate } from './database.ts';
+import type { DBMissionTemplate } from '../database.ts';
 import MissionTemplateLogs from './mission-template-logs.ts';
 import type { MissionTemplateList } from '../types.ts';
 export default class MissionTemplate {

package/dist/types/src/base/notification.d.ts

@@ -1,5 +1,5 @@
-import { NotificationType } from './database.ts';
-import type { DBNotification } from './database.ts';
+import { NotificationType } from '../database.ts';
+import type { DBNotification } from '../database.ts';
 export { NotificationType };
 export default class TAKNotification {
     id: string;

package/dist/types/src/base/subscription-chat.d.ts

@@ -1,4 +1,4 @@
-import type { DBSubscriptionChat } from './database.ts';
+import type { DBSubscriptionChat } from '../database.ts';
 import { type Observable } from 'dexie';
 import type Atlas from '../workers/atlas.ts';
 import type { Remote } from 'comlink';

package/dist/types/src/base/subscription-contents.d.ts

@@ -1,4 +1,4 @@
-import type { DBSubscriptionContent } from './database.ts';
+import type { DBSubscriptionContent } from '../database.ts';
 import type { Mission } from '../types.ts';
 /**
  * High Level Wrapper around Mission Contents (file attachments)

package/dist/types/src/base/subscription-log.d.ts

@@ -1,4 +1,4 @@
-import type { DBSubscriptionLog } from './database.ts';
+import type { DBSubscriptionLog } from '../database.ts';
 import type { MissionLog } from '../types.ts';
 /**
  * High Level Wrapper around the Data/Mission Sync API

package/dist/types/src/components/CloudTAK/Menu/Mission/MissionLog.vue.d.ts

@@ -1,4 +1,4 @@
-import type { DBSubscriptionLog } from '../../../../base/database.ts';
+import type { DBSubscriptionLog } from '../../../../database.ts';
 import Subscription from '../../../../base/subscription.ts';
 type __VLS_Props = {
     log: DBSubscriptionLog;

package/dist/types/src/components/CloudTAK/util/Icons.vue.d.ts

@@ -7,6 +7,10 @@ declare const __VLS_export: import("vue").DefineComponent<import("vue").ExtractP
         type: BooleanConstructor;
         default: boolean;
     };
+    refreshKey: {
+        type: NumberConstructor;
+        default: number;
+    };
 }>, {}, {}, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").PublicProps, Readonly<import("vue").ExtractPropTypes<{
     iconset: {
         type: StringConstructor;
@@ -16,9 +20,14 @@ declare const __VLS_export: import("vue").DefineComponent<import("vue").ExtractP
         type: BooleanConstructor;
         default: boolean;
     };
+    refreshKey: {
+        type: NumberConstructor;
+        default: number;
+    };
 }>> & Readonly<{}>, {
     iconset: string;
     labels: boolean;
+    refreshKey: number;
 }, {}, {}, {}, string, import("vue").ComponentProvideOptions, true, {}, any>;
 declare const _default: typeof __VLS_export;
 export default _default;

package/dist/types/src/{base/database.d.ts → database.d.ts}

@@ -1,5 +1,5 @@
 import Dexie, { type EntityTable } from 'dexie';
-import type { Feature, GroupChannel, Mission, MissionRole, MissionChange, MissionLog, Contact, Server } from '../types.ts';
+import type { Feature, GroupChannel, Mission, MissionRole, MissionChange, MissionLog, Contact, Server } from './types.ts';
 export interface DBIcon {
     /** Maplibre image id, e.g. "<iconsetUid>:<icon-path-without-extension>" */
     name: string;
@@ -48,6 +48,7 @@ export interface DBIconset {
     version: number;
     name: string;
     username: string | null;
+    username_internal: boolean;
     default_group: string | null;
     default_friendly: string | null;
     default_hostile: string | null;

package/dist/types/src/stores/map.d.ts

@@ -4,7 +4,7 @@ import MenuManager from './modules/menu.ts';
 import BottomBarManager from './modules/bottombar.ts';
 import * as Comlink from 'comlink';
 import COT from '../base/cot.ts';
-import type { DatabaseType } from '../base/database.ts';
+import type { DatabaseType } from '../database.ts';
 import { LocationState } from '../base/events.ts';
 import Overlay from '../base/overlay.ts';
 import Subscription from '../base/subscription.ts';

package/dist/types/src/stores/modules/icons.d.ts

@@ -1,7 +1,7 @@
 import type { Map as MapLibreMap } from 'maplibre-gl';
 import type * as Comlink from 'comlink';
 import type Atlas from '../../workers/atlas.ts';
-import { type DBIconset } from '../../base/database.ts';
+import { type DBIconset } from '../../database.ts';
 export default class IconManager {
     private cache;
     private map;
@@ -51,7 +51,9 @@ export default class IconManager {
      * reference a specific iconset so it is available even if the user-wide
      * hydrate hasn't completed yet.
      */
-    addIconset(uid: string): Promise<void>;
+    addIconset(uid: string, opts?: {
+        force?: boolean;
+    }): Promise<void>;
     removeIconset(uid: string): Promise<void>;
     private applyHydrateResult;
     private purgeMapImagesForIconset;

package/dist/types/src/workers/atlas-icons.d.ts

@@ -7,6 +7,8 @@ export default class AtlasIcons {
     hydrate(opts?: {
         force?: boolean;
     }): Promise<IconHydrateResult>;
-    addIconset(uid: string): Promise<boolean>;
+    addIconset(uid: string, opts?: {
+        force?: boolean;
+    }): Promise<boolean>;
     removeIconset(uid: string): Promise<boolean>;
 }

package/package.json

@@ -1,7 +1,7 @@
 {
     "name": "@tak-ps/cloudtak",
     "type": "module",
-    "version": "13.0.0",
+    "version": "13.0.2",
     "types": "dist/types/plugin.d.ts",
     "files": [
         "dist/types"