@enyo-energy/energy-app-sdk 0.0.35 → 0.0.37

package/README.md

@@ -42,21 +42,7 @@ npm install @enyo-energy/energy-app-sdk
 Create a basic Energy App that responds to system events:
 
 ```typescript
-import { EnergyApp, defineEnergyAppPackage, EnergyAppPackageCategory } from '@enyo-energy/energy-app-sdk';
-
-// Define your package
-const packageDefinition = defineEnergyAppPackage({
-    version: '1',
-    packageName: 'my-energy-app',
-    categories: [EnergyAppPackageCategory.EnergyManagement],
-    storeEntry: [{
-        language: 'en',
-        title: 'My Energy App',
-        shortDescription: 'A simple energy management app',
-        description: 'This app demonstrates basic energy management capabilities'
-    }],
-    permissions: ['Storage', 'SendDataBusValues']
-});
+import { EnergyApp, defineEnergyAppPackage, EnergyAppPackageCategory, EnergyAppStateEnum } from '@enyo-energy/energy-app-sdk';
 
 // Initialize the Energy App
 const energyApp = new EnergyApp();
@@ -66,7 +52,7 @@ energyApp.register((packageName: string, version: number) => {
     console.log(`System is ${energyApp.isSystemOnline() ? 'online' : 'offline'}`);
 
     // Set app state to running
-    energyApp.updateEnergyAppState('running');
+    energyApp.updateEnergyAppState(EnergyAppStateEnum.Running);
 
     // Your app logic starts here
     startApp();
@@ -104,7 +90,7 @@ const energyApp = new EnergyApp();
 // Register startup callback
 energyApp.register((packageName, version) => {
     console.log(`${packageName} v${version} started`);
-    energyApp.updateEnergyAppState('running');
+    energyApp.updateEnergyAppState(EnergyAppStateEnum.Running);
 });
 
 // Register shutdown callback

package/dist/cjs/packages/energy-app-authentication.d.cts

@@ -1,4 +1,4 @@
-import { EnyoAuthenticateState, EnyoAuthentication, EnyoAuthenticationResponse, EnyoOauthAuthenticationParameters, EnyoOauthAuthenticationRedirectUrlResponse } from "../types/enyo-authentication.cjs";
+import { EnyoAuthenticateState, EnyoAuthentication, EnyoAuthenticationResponse, EnyoOauthAuthenticationStart, EnyoOauthAuthenticationRedirectUrlResponse } from "../types/enyo-authentication.cjs";
 /**
  * Interface for requesting user authentication for appliances or the entire package.
  * Provides methods to handle authentication requests, listen for responses, and manage authentication state.
@@ -15,7 +15,7 @@ export interface EnergyAppAuthentication {
     /**
      * If you use oauth with clientIdName and clientSecretName, you need to listen to this and respond with the redirect url
      */
-    listenForOauthParameters(listener: (response: EnyoOauthAuthenticationParameters) => Promise<EnyoOauthAuthenticationRedirectUrlResponse>): string;
+    listenForOauthStart(listener: (response: EnyoOauthAuthenticationStart) => Promise<EnyoOauthAuthenticationRedirectUrlResponse>): string;
     /**
      * Adds a listener for authentication responses.
      * The listener will be called when the user completes the authentication process.

package/dist/cjs/types/enyo-authentication.d.cts

@@ -18,9 +18,8 @@ export interface EnyoOauthAuthentication {
     /** If the client id and client secret need to be provided by the user*/
     clientIdName?: EnyoPackageConfigurationTranslatedValue[];
     clientSecretName?: EnyoPackageConfigurationTranslatedValue[];
-    redirectUrl?: string;
 }
-export interface EnyoOauthAuthenticationParameters {
+export interface EnyoOauthAuthenticationStart {
     clientId?: string;
     clientSecret?: string;
 }

package/dist/cjs/version.cjs

@@ -9,7 +9,7 @@ exports.getSdkVersion = getSdkVersion;
 /**
  * Current version of the enyo Energy App SDK.
  */
-exports.SDK_VERSION = '0.0.35';
+exports.SDK_VERSION = '0.0.37';
 /**
  * Gets the current SDK version.
  * @returns The semantic version string of the SDK

package/dist/cjs/version.d.cts

@@ -5,7 +5,7 @@
 /**
  * Current version of the enyo Energy App SDK.
  */
-export declare const SDK_VERSION = "0.0.35";
+export declare const SDK_VERSION = "0.0.37";
 /**
  * Gets the current SDK version.
  * @returns The semantic version string of the SDK

package/dist/packages/energy-app-authentication.d.ts

@@ -1,4 +1,4 @@
-import { EnyoAuthenticateState, EnyoAuthentication, EnyoAuthenticationResponse, EnyoOauthAuthenticationParameters, EnyoOauthAuthenticationRedirectUrlResponse } from "../types/enyo-authentication.js";
+import { EnyoAuthenticateState, EnyoAuthentication, EnyoAuthenticationResponse, EnyoOauthAuthenticationStart, EnyoOauthAuthenticationRedirectUrlResponse } from "../types/enyo-authentication.js";
 /**
  * Interface for requesting user authentication for appliances or the entire package.
  * Provides methods to handle authentication requests, listen for responses, and manage authentication state.
@@ -15,7 +15,7 @@ export interface EnergyAppAuthentication {
     /**
      * If you use oauth with clientIdName and clientSecretName, you need to listen to this and respond with the redirect url
      */
-    listenForOauthParameters(listener: (response: EnyoOauthAuthenticationParameters) => Promise<EnyoOauthAuthenticationRedirectUrlResponse>): string;
+    listenForOauthStart(listener: (response: EnyoOauthAuthenticationStart) => Promise<EnyoOauthAuthenticationRedirectUrlResponse>): string;
     /**
      * Adds a listener for authentication responses.
      * The listener will be called when the user completes the authentication process.

package/dist/types/enyo-authentication.d.ts

@@ -18,9 +18,8 @@ export interface EnyoOauthAuthentication {
     /** If the client id and client secret need to be provided by the user*/
     clientIdName?: EnyoPackageConfigurationTranslatedValue[];
     clientSecretName?: EnyoPackageConfigurationTranslatedValue[];
-    redirectUrl?: string;
 }
-export interface EnyoOauthAuthenticationParameters {
+export interface EnyoOauthAuthenticationStart {
     clientId?: string;
     clientSecret?: string;
 }

package/dist/version.d.ts

@@ -5,7 +5,7 @@
 /**
  * Current version of the enyo Energy App SDK.
  */
-export declare const SDK_VERSION = "0.0.35";
+export declare const SDK_VERSION = "0.0.37";
 /**
  * Gets the current SDK version.
  * @returns The semantic version string of the SDK

package/dist/version.js

@@ -5,7 +5,7 @@
 /**
  * Current version of the enyo Energy App SDK.
  */
-export const SDK_VERSION = '0.0.35';
+export const SDK_VERSION = '0.0.37';
 /**
  * Gets the current SDK version.
  * @returns The semantic version string of the SDK

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@enyo-energy/energy-app-sdk",
-  "version": "0.0.35",
+  "version": "0.0.37",
   "description": "enyo Energy App SDK",
   "type": "module",
   "main": "dist/index.js",
@@ -15,7 +15,7 @@
     "README.md"
   ],
   "publishConfig": {
-    "access": "restricted"
+    "access": "public"
   },
   "repository": {
     "type": "git",