@phystack/hub-device 4.4.30

package/README.md

@@ -0,0 +1,12 @@
+## Gridapp Settings
+
+### Methods
+
+#### useSettings<Settings>(): Settings
+Returns an object of settings for current application or null if settings haven't been loaded yet
+
+#### useAppInfo(): AppInfo
+Return as object containing application name, release, etc
+
+#### AppInfo.device: DeviceInfo?
+Contains device id and name (without org prefix), only on GridOS

package/dist/index.d.ts

@@ -0,0 +1,114 @@
+import { Socket, SocketOptions, ManagerOptions } from 'socket.io-client';
+import { DeviceStatus, DeviceTwinReportedProperties, EdgeTwinReportedProperties, ScreenTwinReportedProperties, TwinResponse, TwinStatusEnum, PeripheralTwinReportedProperties } from './types/twin.types';
+import { Job } from './types/job.types';
+export type MyIoOptions = Partial<ManagerOptions & SocketOptions>;
+interface EventPayload<T = any> {
+    twinId?: string;
+    deviceId?: string;
+    status?: TwinStatusEnum;
+    data?: T;
+}
+interface MigratedCredentials {
+    deviceId: string;
+    accessKey: string;
+    deviceSerial: string;
+    phyhubUrl: string;
+    region: string;
+}
+export declare const connectToPhyHub: (gridEnv?: string, osVersion?: string, migratedCredentials?: MigratedCredentials | undefined) => Promise<any>;
+export declare const getPhyHubInstance: () => Promise<HubDevice | null>;
+export declare const getProvisioningInfo: () => Promise<{
+    provisioningCode: any;
+    deviceSerial: any;
+}>;
+export declare class HubDevice {
+    gridEnv: string;
+    osVersion: string;
+    phyhubUrl: string | null;
+    deviceId: string | null;
+    accessKey: string | null;
+    deviceSerial: string | null;
+    region: string | null;
+    socket: Socket | null;
+    private socketConnected;
+    private socketAuthenticated;
+    private onTwinUpdate;
+    private onTwinRemove;
+    private emitQueue;
+    private emitAuthQueue;
+    private scheduler;
+    private deletedTwins;
+    private intervals;
+    private peripheralTwinMutex;
+    private eventCallbacks;
+    private reconnectListeners;
+    private authReconnectListeners;
+    constructor(phyhubUrl: string, deviceId: string, accessKey: string, deviceSerial: string, gridEnv: string | undefined, osVersion: string | undefined, region: string);
+    setTwinUpdateHandler(callback: (twins: TwinResponse) => void): void;
+    setTwinRemoveHandler(callback: (twins: TwinResponse) => void): void;
+    isConnected(): boolean;
+    isAuthenticated(): boolean;
+    connect(): Promise<this | undefined>;
+    on(event: string, callback: (data: any) => void): void;
+    emit(...args: any): void;
+    emitAuth(...args: any): void;
+    private processEmitQueue;
+    private processEmitAuthQueue;
+    private executeReconnectListeners;
+    private executeAuthReconnectListeners;
+    private connectSocket;
+    getDeviceStatus: () => Promise<DeviceStatus>;
+    getDeviceInstance: () => Promise<{
+        twin: any;
+    } | {
+        twin?: undefined;
+    }>;
+    getDeviceNetworks: () => Promise<{
+        networkInterfaces: any;
+        wifiInterfaces: any;
+        wifiNetworks: any;
+        wifiConnections: any;
+    }>;
+    getScreenInstance: () => Promise<{
+        twin?: undefined;
+    } | {
+        twin: any;
+    }>;
+    connectDevice(callback: (data: any) => void): Promise<void>;
+    private transformCachedTwinsToArray;
+    private cacheTwins;
+    private removeCachedTwin;
+    getCachedTwins: (twinId?: string | undefined) => Promise<any>;
+    reportScreenInstanceProperties(properties: EventPayload<ScreenTwinReportedProperties>, callback: (data: any) => void): Promise<void>;
+    getEdgeInstance(payload: EventPayload): Promise<{
+        twin: any;
+    } | {
+        twin?: undefined;
+    }>;
+    sendEventSignal(payload: EventPayload<Record<string, any>>): Promise<void>;
+    sendClientSignal(payload: EventPayload<Record<string, any>>): Promise<void>;
+    sendSessionSignal(payload: EventPayload<Record<string, any>>): Promise<void>;
+    reportEdgeTwinProperties(instanceTwinId: string, properties: EdgeTwinReportedProperties, callback: (data: any) => void): Promise<void>;
+    reportDeviceTwinProperties(instanceTwinId: string, properties: DeviceTwinReportedProperties, callback: (data: any) => void): Promise<void>;
+    reportDeviceJob(instanceTwinId: string, job: Job, callback: (data: any) => void): Promise<void>;
+    reportPeripheralTwinProperties(instanceTwinId: string, properties: PeripheralTwinReportedProperties, callback?: (data: any) => void): Promise<void>;
+    setScheduler(scheduler: any): void;
+    private cachePeripheralTwins;
+    getPeripheralTwins(payload: EventPayload<{
+        instanceId: string;
+    }>): Promise<{
+        peripheralTwins: Record<string, TwinResponse>;
+    }>;
+    onReconnect(listener: () => void): void;
+    onAuthReconnect(listener: () => void): void;
+}
+declare const _default: {
+    connectToPhyHub: (gridEnv?: string, osVersion?: string, migratedCredentials?: MigratedCredentials | undefined) => Promise<any>;
+    getPhyHubInstance: () => Promise<HubDevice | null>;
+    getProvisioningInfo: () => Promise<{
+        provisioningCode: any;
+        deviceSerial: any;
+    }>;
+};
+export default _default;
+//# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,EAAE,aAAa,EAAE,cAAc,EAAE,MAAM,kBAAkB,CAAC;AAOzE,OAAO,EAEL,YAAY,EACZ,4BAA4B,EAE5B,0BAA0B,EAC1B,4BAA4B,EAC5B,YAAY,EACZ,cAAc,EAEd,gCAAgC,EACjC,MAAM,oBAAoB,CAAC;AAC5B,OAAO,EAAE,GAAG,EAAE,MAAM,mBAAmB,CAAC;AAKxC,MAAM,MAAM,WAAW,GAAG,OAAO,CAAC,cAAc,GAAG,aAAa,CAAC,CAAC;AAClE,UAAU,YAAY,CAAC,CAAC,GAAG,GAAG;IAC5B,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,MAAM,CAAC,EAAE,cAAc,CAAC;IACxB,IAAI,CAAC,EAAE,CAAC,CAAC;CACV;AAED,UAAU,mBAAmB;IAC3B,QAAQ,EAAE,MAAM,CAAC;IACjB,SAAS,EAAE,MAAM,CAAC;IAClB,YAAY,EAAE,MAAM,CAAC;IACrB,SAAS,EAAE,MAAM,CAAC;IAClB,MAAM,EAAE,MAAM,CAAC;CAChB;AA8BD,eAAO,MAAM,eAAe,GAC1B,UAAS,MAAe,EACxB,YAAW,MAAc,EACzB,sBAAqB,mBAAmB,GAAG,SAAqB,iBAyIjE,CAAC;AAEF,eAAO,MAAM,iBAAiB,iCAE7B,CAAC;AAEF,eAAO,MAAM,mBAAmB;;;EAwB/B,CAAC;AAEF,qBAAa,SAAS;IACb,OAAO,EAAE,MAAM,CAAC;IAChB,SAAS,EAAE,MAAM,CAAC;IAClB,SAAS,EAAE,MAAM,GAAG,IAAI,CAAQ;IAChC,QAAQ,EAAE,MAAM,GAAG,IAAI,CAAQ;IAC/B,SAAS,EAAE,MAAM,GAAG,IAAI,CAAQ;IAChC,YAAY,EAAE,MAAM,GAAG,IAAI,CAAQ;IACnC,MAAM,EAAE,MAAM,GAAG,IAAI,CAAQ;IAE7B,MAAM,EAAE,MAAM,GAAG,IAAI,CAAQ;IACpC,OAAO,CAAC,eAAe,CAAkB;IACzC,OAAO,CAAC,mBAAmB,CAAkB;IAC7C,OAAO,CAAC,YAAY,CAAgD;IACpE,OAAO,CAAC,YAAY,CAAgD;IACpE,OAAO,CAAC,SAAS,CAAa;IAC9B,OAAO,CAAC,aAAa,CAAa;IAClC,OAAO,CAAC,SAAS,CAAoB;IACrC,OAAO,CAAC,YAAY,CAAgB;IAEpC,OAAO,CAAC,SAAS,CAAW;IAC5B,OAAO,CAAC,mBAAmB,CAAe;IAC1C,OAAO,CAAC,cAAc,CAAsD;IAC5E,OAAO,CAAC,kBAAkB,CAAyB;IACnD,OAAO,CAAC,sBAAsB,CAAyB;gBAGrD,SAAS,EAAE,MAAM,EACjB,QAAQ,EAAE,MAAM,EAChB,SAAS,EAAE,MAAM,EACjB,YAAY,EAAE,MAAM,EACpB,OAAO,EAAE,MAAM,YAAS,EACxB,SAAS,EAAE,MAAM,YAAQ,EACzB,MAAM,EAAE,MAAM;IAWT,oBAAoB,CAAC,QAAQ,EAAE,CAAC,KAAK,EAAE,YAAY,KAAK,IAAI;IAK5D,oBAAoB,CAAC,QAAQ,EAAE,CAAC,KAAK,EAAE,YAAY,KAAK,IAAI;IAK5D,WAAW;IAIX,eAAe;IAIT,OAAO;IAuBb,EAAE,CAAC,KAAK,EAAE,MAAM,EAAE,QAAQ,EAAE,CAAC,IAAI,EAAE,GAAG,KAAK,IAAI;IA0B/C,IAAI,CAAC,GAAG,IAAI,EAAE,GAAG;IAejB,QAAQ,CAAC,GAAG,IAAI,EAAE,GAAG;IAoB5B,OAAO,CAAC,gBAAgB;IAmBxB,OAAO,CAAC,oBAAoB;IAmB5B,OAAO,CAAC,yBAAyB;IAUjC,OAAO,CAAC,6BAA6B;YAUvB,aAAa;IAwGpB,eAAe,QAAa,OAAO,CAAC,YAAY,CAAC,CAoDtD;IAEK,iBAAiB;;;;OAkBtB;IAEK,iBAAiB;;;;;OAmBtB;IAEK,iBAAiB;;;;OAuBtB;IAEW,aAAa,CAAC,QAAQ,EAAE,CAAC,IAAI,EAAE,GAAG,KAAK,IAAI;YAqI1C,2BAA2B;IAezC,OAAO,CAAC,UAAU,CAsEhB;YAEY,gBAAgB;IAwDvB,cAAc,GAAU,SAAQ,MAAM,GAAG,SAAqB,kBAWnE;IAEW,8BAA8B,CACzC,UAAU,EAAE,YAAY,CAAC,4BAA4B,CAAC,EACtD,QAAQ,EAAE,CAAC,IAAI,EAAE,GAAG,KAAK,IAAI;IA6BlB,eAAe,CAC1B,OAAO,EAAE,YAAY;;;;;IAuBV,eAAe,CAC1B,OAAO,EAAE,YAAY,CAAC,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;IAY/B,gBAAgB,CAC3B,OAAO,EAAE,YAAY,CAAC,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;IAY/B,iBAAiB,CAC5B,OAAO,EAAE,YAAY,CAAC,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;IAY/B,wBAAwB,CACnC,cAAc,EAAE,MAAM,EACtB,UAAU,EAAE,0BAA0B,EACtC,QAAQ,EAAE,CAAC,IAAI,EAAE,GAAG,KAAK,IAAI;IAqBlB,0BAA0B,CACrC,cAAc,EAAE,MAAM,EACtB,UAAU,EAAE,4BAA4B,EACxC,QAAQ,EAAE,CAAC,IAAI,EAAE,GAAG,KAAK,IAAI;IAqBlB,eAAe,CAAC,cAAc,EAAE,MAAM,EAAE,GAAG,EAAE,GAAG,EAAE,QAAQ,EAAE,CAAC,IAAI,EAAE,GAAG,KAAK,IAAI;IAoB/E,8BAA8B,CACzC,cAAc,EAAE,MAAM,EACtB,UAAU,EAAE,gCAAgC,EAC5C,QAAQ,CAAC,EAAE,CAAC,IAAI,EAAE,GAAG,KAAK,IAAI;IAsBzB,YAAY,CAAC,SAAS,EAAE,GAAG;YAQpB,oBAAoB;IAcrB,kBAAkB,CAAC,OAAO,EAAE,YAAY,CAAC;QAAE,UAAU,EAAE,MAAM,CAAA;KAAE,CAAC;;;IA6CtE,WAAW,CAAC,QAAQ,EAAE,MAAM,IAAI;IAKhC,eAAe,CAAC,QAAQ,EAAE,MAAM,IAAI;CAI5C;;gCA9nCU,MAAM,cACJ,MAAM,wBACI,mBAAmB,GAAG,SAAS;;;;;;;AAgoCtD,wBAIE"}