@placeos/ts-client 4.7.10 → 4.8.1

package/dist/signage/functions.d.ts

@@ -1,7 +1,8 @@
 import { HttpJsonOptions } from '../http/interfaces';
-import { SignageMediaQueryOptions, SignageMetrics } from './interfaces';
+import { SignageMediaQueryOptions, SignageMetrics, SignagePluginQueryOptions } from './interfaces';
 import { SignageMedia } from './media.class';
 import { SignagePlaylist, SignagePlaylistMedia } from './playlist.class';
+import { SignagePlugin } from './plugin.class';
 /**
  * Get the data for a signage item
  * @param id ID of the signage item to retrieve
@@ -104,3 +105,32 @@ export declare function approveSignagePlaylist(id: string): import('rxjs').Obser
  * @param form_data New list of media IDs for the playlist
  */
 export declare function updateSignagePlaylistMedia(id: string, form_data: string[]): import('rxjs').Observable<SignagePlaylistMedia>;
+/**
+ * Query the available signage plugins
+ * @param query_params Query parameters to add the to request URL
+ */
+export declare function querySignagePlugins(query_params?: SignagePluginQueryOptions): import('..').QueryResponse<SignagePlugin>;
+/**
+ * Get the data for a signage plugin
+ * @param id ID of the signage plugin to retrieve
+ * @param query_params Query parameters to add the to request URL
+ */
+export declare function showSignagePlugin(id: string, query_params?: SignagePluginQueryOptions): import('rxjs').Observable<SignagePlugin>;
+/**
+ * Update the signage plugin in the database
+ * @param id ID of the signage plugin
+ * @param form_data New values for the signage plugin
+ * @param method HTTP verb to use on request. Defaults to `patch`
+ */
+export declare function updateSignagePlugin(id: string, form_data: Partial<SignagePlugin>, method?: 'put' | 'patch'): import('rxjs').Observable<SignagePlugin>;
+/**
+ * Add a new signage plugin to the database
+ * @param form_data Signage plugin data
+ */
+export declare function addSignagePlugin(form_data: Partial<SignagePlugin>): import('rxjs').Observable<SignagePlugin>;
+/**
+ * Remove a signage plugin from the database
+ * @param id ID of the signage plugin
+ * @param query_params Query parameters to add the to request URL
+ */
+export declare function removeSignagePlugin(id: string, query_params?: Record<string, any>): import('rxjs').Observable<import('../utilities/types').HashMap<any>>;

package/dist/signage/interfaces.d.ts

@@ -17,3 +17,6 @@ export interface SignagePlaylistRevisionsOptions {
     /** Maximum number of revisions to return */
     limit?: number;
 }
+/** Allowable query parameters for signage plugins index endpoint */
+export interface SignagePluginQueryOptions extends PlaceResourceQueryOptions {
+}

package/dist/signage/media.class.d.ts

@@ -1,4 +1,5 @@
-export type MediaType = 'unknown' | 'image' | 'video' | 'audio' | 'plugin' | 'webpage' | 'externalimage';
+import { HashMap } from '../utilities/types';
+export type MediaType = 'unknown' | 'image' | 'video' | 'audio' | 'plugin' | 'webpage' | 'externalimage' | 'external_image';
 export declare enum MediaAnimation {
     Default = 0,
     Cut = 1,
@@ -25,6 +26,8 @@ export declare class SignageMedia {
     readonly media_uri: string;
     readonly media_id: string;
     readonly thumbnail_id: string;
+    readonly plugin_id: string;
+    readonly plugin_params: HashMap;
     readonly play_count: number;
     readonly valid_from?: number;
     readonly valid_until?: number;

package/dist/signage/plugin.class.d.ts

@@ -0,0 +1,16 @@
+import { HashMap } from '../utilities/types';
+export type SignagePlaybackType = 'static' | 'interactive' | 'playsthrough';
+export declare class SignagePlugin {
+    readonly id: string;
+    readonly created_at: number;
+    readonly updated_at: number;
+    readonly name: string;
+    readonly description: string;
+    readonly uri: string;
+    readonly playback_type: SignagePlaybackType;
+    readonly authority_id: string;
+    readonly enabled: boolean;
+    readonly params: HashMap;
+    readonly defaults: HashMap;
+    constructor(data?: Partial<SignagePlugin>);
+}

package/dist/systems/system.d.ts

@@ -38,6 +38,8 @@ export declare class PlaceSystem extends PlaceResource {
     /** URL for the timetable UI linked to the system */
     readonly timetable_url: string;
     /** URLs for requesting snapshots of the assosiated camera */
+    readonly camera_snapshot_url: string;
+    /** URLs for requesting snapshots of the assosiated camera */
     readonly camera_snapshot_urls: string[];
     /** URL for managing the attached camera */
     readonly camera_url: string;

package/package.json

@@ -1,5 +1,5 @@
 {
-    "version": "4.7.10",
+    "version": "4.8.1",
     "license": "MIT",
     "name": "@placeos/ts-client",
     "author": "Alex Sorafumo <alex@place.tech>",

package/src/api.ts

@@ -363,37 +363,48 @@ export { PlaceZone } from './zones/zone';
 export {
     addSignageMedia,
     addSignagePlaylist,
+    addSignagePlugin,
     approveSignagePlaylist,
     listSignagePlaylistMedia,
     listSignagePlaylistMediaRevisions,
     mediaThumbnail,
     querySignageMedia,
     querySignagePlaylists,
+    querySignagePlugins,
     removeSignageMedia,
     removeSignagePlaylist,
+    removeSignagePlugin,
     showSignage,
     showSignageMedia,
     showSignageMetrics,
     showSignagePlaylist,
+    showSignagePlugin,
     updateSignageMedia,
     updateSignagePlaylist,
     updateSignagePlaylistMedia,
+    updateSignagePlugin,
 } from './signage/functions';
 export type {
     SignageMediaQueryOptions,
     SignageMetrics,
     SignagePlaylistQueryOptions,
     SignagePlaylistRevisionsOptions,
+    SignagePluginQueryOptions,
 } from './signage/interfaces';
 export {
     MediaAnimation,
     SignageMedia,
     type MediaOrientation,
+    type MediaType,
 } from './signage/media.class';
 export {
     SignagePlaylist,
     SignagePlaylistMedia,
 } from './signage/playlist.class';
+export {
+    SignagePlugin,
+    type SignagePlaybackType,
+} from './signage/plugin.class';
 
 export { addAnswer, queryAnswers } from './staff/answers/functions';
 export type { AnswerQueryOptions } from './staff/answers/interfaces';

package/src/signage/functions.ts

@@ -2,9 +2,14 @@ import { create, query, remove, show, update } from '../api';
 import { apiEndpoint } from '../auth';
 import { HttpJsonOptions } from '../http/interfaces';
 import { task } from '../resources/functions';
-import { SignageMediaQueryOptions, SignageMetrics } from './interfaces';
+import {
+    SignageMediaQueryOptions,
+    SignageMetrics,
+    SignagePluginQueryOptions,
+} from './interfaces';
 import { SignageMedia } from './media.class';
 import { SignagePlaylist, SignagePlaylistMedia } from './playlist.class';
+import { SignagePlugin } from './plugin.class';
 
 /**
  * @private
@@ -282,3 +287,86 @@ export function updateSignagePlaylistMedia(id: string, form_data: string[]) {
             new SignagePlaylistMedia(value),
     });
 }
+
+/**
+ * @private
+ */
+const PLUGINS_PATH = 'signage/plugins';
+
+/** Convert raw server data to a signage plugin object */
+function processPlugin(item: Partial<SignagePlugin>) {
+    return new SignagePlugin(item);
+}
+
+/**
+ * Query the available signage plugins
+ * @param query_params Query parameters to add the to request URL
+ */
+export function querySignagePlugins(
+    query_params: SignagePluginQueryOptions = {},
+) {
+    return query({ query_params, fn: processPlugin, path: PLUGINS_PATH });
+}
+
+/**
+ * Get the data for a signage plugin
+ * @param id ID of the signage plugin to retrieve
+ * @param query_params Query parameters to add the to request URL
+ */
+export function showSignagePlugin(
+    id: string,
+    query_params: SignagePluginQueryOptions = {},
+) {
+    return show({
+        id,
+        query_params,
+        fn: processPlugin,
+        path: PLUGINS_PATH,
+    });
+}
+
+/**
+ * Update the signage plugin in the database
+ * @param id ID of the signage plugin
+ * @param form_data New values for the signage plugin
+ * @param method HTTP verb to use on request. Defaults to `patch`
+ */
+export function updateSignagePlugin(
+    id: string,
+    form_data: Partial<SignagePlugin>,
+    method: 'put' | 'patch' = 'patch',
+) {
+    return update({
+        id,
+        form_data,
+        query_params: {},
+        method,
+        fn: processPlugin,
+        path: PLUGINS_PATH,
+    });
+}
+
+/**
+ * Add a new signage plugin to the database
+ * @param form_data Signage plugin data
+ */
+export function addSignagePlugin(form_data: Partial<SignagePlugin>) {
+    return create({
+        form_data,
+        query_params: {},
+        fn: processPlugin,
+        path: PLUGINS_PATH,
+    });
+}
+
+/**
+ * Remove a signage plugin from the database
+ * @param id ID of the signage plugin
+ * @param query_params Query parameters to add the to request URL
+ */
+export function removeSignagePlugin(
+    id: string,
+    query_params: Record<string, any> = {},
+) {
+    return remove({ id, query_params, path: PLUGINS_PATH });
+}

package/src/signage/interfaces.ts

@@ -20,3 +20,6 @@ export interface SignagePlaylistRevisionsOptions {
     /** Maximum number of revisions to return */
     limit?: number;
 }
+
+/** Allowable query parameters for signage plugins index endpoint */
+export interface SignagePluginQueryOptions extends PlaceResourceQueryOptions {}

package/src/signage/media.class.ts

@@ -1,4 +1,5 @@
 import { getUnixTime } from 'date-fns';
+import { HashMap } from '../utilities/types';
 
 export type MediaType =
     | 'unknown'
@@ -7,7 +8,8 @@ export type MediaType =
     | 'audio'
     | 'plugin'
     | 'webpage'
-    | 'externalimage';
+    | 'externalimage'
+    | 'external_image';
 
 export enum MediaAnimation {
     Default = 0,
@@ -41,6 +43,8 @@ export class SignageMedia {
     public readonly media_uri: string;
     public readonly media_id: string;
     public readonly thumbnail_id: string;
+    public readonly plugin_id: string;
+    public readonly plugin_params: HashMap;
     public readonly play_count: number;
     public readonly valid_from?: number;
     public readonly valid_until?: number;
@@ -71,6 +75,8 @@ export class SignageMedia {
         this.media_uri = data.media_uri || '';
         this.media_id = data.media_id || '';
         this.thumbnail_id = data.thumbnail_id || '';
+        this.plugin_id = data.plugin_id || '';
+        this.plugin_params = data.plugin_params || {};
         this.play_count = data.play_count || 0;
         this.valid_from = data.valid_from;
         this.valid_until = data.valid_until;

package/src/signage/plugin.class.ts

@@ -0,0 +1,31 @@
+import { HashMap } from '../utilities/types';
+
+export type SignagePlaybackType = 'static' | 'interactive' | 'playsthrough';
+
+export class SignagePlugin {
+    public readonly id: string;
+    public readonly created_at: number;
+    public readonly updated_at: number;
+    public readonly name: string;
+    public readonly description: string;
+    public readonly uri: string;
+    public readonly playback_type: SignagePlaybackType;
+    public readonly authority_id: string;
+    public readonly enabled: boolean;
+    public readonly params: HashMap;
+    public readonly defaults: HashMap;
+
+    constructor(data: Partial<SignagePlugin> = {}) {
+        this.id = data.id || '';
+        this.created_at = data.created_at || 0;
+        this.updated_at = data.updated_at || 0;
+        this.name = data.name || '';
+        this.description = data.description || '';
+        this.uri = data.uri || '';
+        this.playback_type = data.playback_type || 'static';
+        this.authority_id = data.authority_id || '';
+        this.enabled = data.enabled ?? true;
+        this.params = data.params || {};
+        this.defaults = data.defaults || {};
+    }
+}

package/src/systems/system.ts

@@ -41,6 +41,8 @@ export class PlaceSystem extends PlaceResource {
     /** URL for the timetable UI linked to the system */
     public readonly timetable_url: string;
     /** URLs for requesting snapshots of the assosiated camera */
+    public readonly camera_snapshot_url: string;
+    /** URLs for requesting snapshots of the assosiated camera */
     public readonly camera_snapshot_urls: string[];
     /** URL for managing the attached camera */
     public readonly camera_url: string;
@@ -85,6 +87,7 @@ export class PlaceSystem extends PlaceResource {
         this.public = raw_data.public ?? false;
         this.installed_ui_devices = raw_data.installed_ui_devices || 0;
         this.support_url = raw_data.support_url || '';
+        this.camera_snapshot_url = raw_data.camera_snapshot_url || '';
         this.camera_snapshot_urls = raw_data.camera_snapshot_urls || [];
         this.camera_url = raw_data.camera_url || '';
         this.timetable_url = raw_data.timetable_url || '';