@scaleflex/widget-companion-client 0.0.1

package/lib/tokenStorage.js

@@ -0,0 +1,21 @@
+'use strict';
+
+/**
+ * This module serves as an Async wrapper for LocalStorage
+ */
+var setItem = function setItem(key, value) {
+  return new Promise(function (resolve) {
+    localStorage.setItem(key, value);
+    resolve();
+  });
+};
+var getItem = function getItem(key) {
+  return Promise.resolve(localStorage.getItem(key));
+};
+var removeItem = function removeItem(key) {
+  return new Promise(function (resolve) {
+    localStorage.removeItem(key);
+    resolve();
+  });
+};
+export { setItem, getItem, removeItem };

package/package.json

@@ -0,0 +1,21 @@
+{
+  "name": "@scaleflex/widget-companion-client",
+  "description": "Client library for communication with Companion. Intended for use in Scaleflex plugins.",
+  "version": "0.0.1",
+  "license": "MIT",
+  "main": "lib/index.js",
+  "types": "types/index.d.ts",
+  "files": [
+    "/dist",
+    "/lib",
+    "/types"
+  ],
+  "publishConfig": {
+    "access": "public"
+  },
+  "dependencies": {
+    "@scaleflex/widget-utils": "^0.0.1",
+    "namespace-emitter": "^2.0.1"
+  },
+  "gitHead": "64ea82e745b7deda36d6794863350e6671e9010d"
+}

package/types/index.d.ts

@@ -0,0 +1,65 @@
+/**
+ * Async storage interface, similar to `localStorage`. This can be used to
+ * implement custom storages for authentication tokens.
+ */
+export interface TokenStorage {
+  setItem: (key: string, value: string) => Promise<void>
+  getItem: (key: string) => Promise<string>
+  removeItem: (key: string) => Promise<void>
+}
+
+export interface RequestClientOptions {
+  companionUrl: string
+  companionHeaders?: object
+}
+
+export class RequestClient {
+  constructor (filerobot: any, opts: RequestClientOptions)
+  get (path: string): Promise<any>
+  post (path: string, data: object): Promise<any>
+  delete (path: string, data: object): Promise<any>
+}
+
+/**
+ * Options for Providers that can be passed in by Filerobot users through
+ * Plugin constructors.
+ */
+export interface PublicProviderOptions extends RequestClientOptions {
+  companionAllowedHosts?: string | RegExp | Array<string | RegExp>
+}
+
+/**
+ * Options for Providers, including internal options that Plugins can set.
+ */
+export interface ProviderOptions extends PublicProviderOptions {
+  provider: string
+  name?: string
+  pluginId: string
+}
+
+export class Provider extends RequestClient {
+  constructor (filerobot: any, opts: ProviderOptions)
+  checkAuth (): Promise<boolean>
+  authUrl (): string
+  fileUrl (id: string): string
+  list (directory: string): Promise<any>
+  logout (redirect?: string): Promise<any>
+  static initPlugin (plugin: any, opts: object, defaultOpts?: object): void
+}
+
+export interface SocketOptions {
+  target: string
+  autoOpen?: boolean
+}
+
+export class Socket {
+  isOpen: boolean
+
+  constructor (opts: SocketOptions)
+  open (): void
+  close (): void
+  send (action: string, payload: any): void
+  on (action: string, handler: (param: any) => void): void
+  once (action: string, handler: (param: any) => void): void
+  emit (action: string, payload: (param: any) => void): void
+}