@picteus/extension-sdk 0.3.3 → 0.4.0

package/dist/picteus-ws-client/runtime.d.ts

@@ -2,7 +2,7 @@
  * Picteus
  * The Picteus API
  *
- * The version of the OpenAPI document: 0.3.0
+ * The version of the OpenAPI document: 0.4.0
  * Contact: edouard@koppasoft.com
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

package/dist/picteus-ws-client/runtime.js

@@ -4,7 +4,7 @@
  * Picteus
  * The Picteus API
  *
- * The version of the OpenAPI document: 0.3.0
+ * The version of the OpenAPI document: 0.4.0
  * Contact: edouard@koppasoft.com
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

package/dist/picteusExtension.d.ts

@@ -1,5 +1,5 @@
 import { Socket } from "socket.io-client";
-import { Configuration, ImageApi, ImageAttachmentApi, Json, RepositoryApi } from "./index.js";
+import { ApiSecretApi, Configuration, ExtensionApi, ImageApi, ImageAttachmentApi, Json, Manifest, MiscellaneousApi, RepositoryApi } from "./index.js";
 export type NotificationValue = Record<string, any>;
 export declare enum NotificationReturnedErrorCause {
     Cancel = 0,
@@ -102,7 +102,7 @@ declare class MessageSender {
     private readonly logger;
     private readonly parameters;
     private readonly socket;
-    private readonly toString;
+    readonly toString: () => string;
     private readonly contextId?;
     constructor(logger: Logger, parameters: ExtensionParameters, socket: Socket, toString: () => string, contextId?: string);
     sendMessage(channel: string, body: Record<string, any>, callback?: (result: any) => Promise<void>): void;
@@ -118,8 +118,10 @@ export declare class Communicator {
 }
 export type SettingsValue = Record<string, any>;
 export declare class PicteusExtension {
+    static getManifest(): Manifest;
     static getSdkVersion(): string;
     static getCacheDirectoryPath(): string;
+    static getExtensionHomeDirectoryPath(): string;
     protected readonly logger: Logger;
     protected readonly parameters: ExtensionParameters;
     protected readonly extensionId: string;
@@ -136,6 +138,9 @@ export declare class PicteusExtension {
     protected onTerminate(): Promise<void>;
     protected onSettings(communicator: Communicator, value: SettingsValue): Promise<void>;
     protected onEvent(communicator: Communicator, event: string, value: NotificationValue): Promise<any>;
+    protected getMiscellaneousApi(): MiscellaneousApi;
+    protected getApiSecretApi(): ApiSecretApi;
+    protected getExtensionApi(): ExtensionApi;
     protected getRepositoryApi(): RepositoryApi;
     protected getImageApi(): ImageApi;
     protected getImageAttachmentApi(): ImageAttachmentApi;

package/dist/picteusExtension.js

@@ -1,10 +1,9 @@
-import path, { dirname } from "node:path";
+import path from "node:path";
 import fs from "node:fs";
-import { fileURLToPath } from "node:url";
 // We do not import the "process" package on purpose, otherwise we get the runtime error "process.on is not a function"
 import console from "node:console";
 import { io } from "socket.io-client";
-import { Configuration, ExtensionApi, ImageApi, ImageAttachmentApi, RepositoryApi } from "./index.js";
+import { ApiSecretApi, Configuration, ExtensionApi, ImageApi, ImageAttachmentApi, ManifestFromJSON, MiscellaneousApi, RepositoryApi } from "./index.js";
 export var NotificationReturnedErrorCause;
 (function (NotificationReturnedErrorCause) {
     NotificationReturnedErrorCause[NotificationReturnedErrorCause["Cancel"] = 0] = "Cancel";
@@ -133,7 +132,7 @@ export class Communicator {
     async launchIntent(intent) {
         return await new Promise((resolve, reject) => {
             this.sendMessage(notificationsChannel, { intent }, async ({ value, cancel, error }) => {
-                this.logger.debug(`Received a result related to the intent '${JSON.stringify(intent)}' for ${this.toString()}`);
+                this.logger.debug(`Received a result related to the intent '${JSON.stringify(intent)}' for ${this.sender.toString()}`);
                 if (cancel !== undefined) {
                     reject(new NotificationReturnedError(cancel, NotificationReturnedErrorCause.Cancel));
                 }
@@ -151,11 +150,17 @@ export class Communicator {
     }
 }
 export class PicteusExtension {
+    static getManifest() {
+        return ManifestFromJSON(JSON.parse(fs.readFileSync(path.join(PicteusExtension.getExtensionHomeDirectoryPath(), "manifest.json"), { encoding: "utf8" })));
+    }
     static getSdkVersion() {
-        return JSON.parse(fs.readFileSync(path.join(dirname(fileURLToPath(import.meta.url)), "..", "package.json"), { encoding: "utf8" })).version;
+        return JSON.parse(fs.readFileSync(path.join(PicteusExtension.getExtensionHomeDirectoryPath(), "package.json"), { encoding: "utf8" })).version;
     }
     static getCacheDirectoryPath() {
-        return path.join(process.cwd(), ".cache");
+        return path.join(PicteusExtension.getExtensionHomeDirectoryPath(), ".cache");
+    }
+    static getExtensionHomeDirectoryPath() {
+        return path.resolve(process.cwd());
     }
     logger = new Logger();
     parameters;
@@ -228,6 +233,15 @@ export class PicteusExtension {
     // noinspection JSUnusedLocalSymbols
     async onEvent(communicator, event, value) {
     }
+    getMiscellaneousApi() {
+        return new MiscellaneousApi(this.configuration);
+    }
+    getApiSecretApi() {
+        return new ApiSecretApi(this.configuration);
+    }
+    getExtensionApi() {
+        return new ExtensionApi(this.configuration);
+    }
     getRepositoryApi() {
         return new RepositoryApi(this.configuration);
     }
@@ -241,7 +255,7 @@ export class PicteusExtension {
         return (await new ExtensionApi(this.configuration).extensionGetSettings({ id: this.extensionId })).value;
     }
     getParameters() {
-        return JSON.parse(fs.readFileSync(path.join(".", "parameters.json"), { encoding: "utf8" }));
+        return JSON.parse(fs.readFileSync(path.join(PicteusExtension.getExtensionHomeDirectoryPath(), "parameters.json"), { encoding: "utf8" }));
     }
     connectSocket() {
         this.logger.info(`Connecting the ${this.toString()} to the server`);
@@ -308,6 +322,17 @@ export class PicteusExtension {
     getApiConfiguration() {
         // This enables to discard the warning log message, caused by the fact that we are issuing HTTPS request on the localhost exposing a self-served certificate
         process.env["NODE_TLS_REJECT_UNAUTHORIZED"] = "0";
-        return new Configuration({ basePath: this.webServicesBaseUrl, apiKey: this.apiKey });
+        return new Configuration({
+            basePath: this.webServicesBaseUrl,
+            apiKey: this.apiKey,
+            middleware: [
+                {
+                    async onError(context) {
+                        this.log.error("The API request issued an error", context.error);
+                        return context.response;
+                    }
+                }
+            ]
+        });
     }
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@picteus/extension-sdk",
-  "version": "0.3.3",
+  "version": "0.4.0",
   "productName": "Picteus TypeScript SDK",
   "description": "The Picteus extension TypeScript SDK.",
   "keywords": [