@smapiot/piral-cloud-node 0.12.3-pre.20220810.1 → 0.12.3

package/lib/index.d.ts

@@ -1,21 +1,4 @@
 declare module "@smapiot/piral-cloud-node" {
-  /**
-   * The options for creating a new service client.
-   */
-  export interface CreateServiceClientOptions {
-    /**
-     * Defines the host to talk to. Set this if you want to communicate
-     * with your own feed service instance.
-     * @default https://feed.piral.cloud
-     */
-    host?: string;
-    /**
-     * Defines the API key to use for making the HTTP calls. Needs
-     * to be provided.
-     */
-    apiKey: string;
-  }
-
   /**
    * Creates a new service client for use in Node.js-based applications.
    * @param options The options for creating the client.
@@ -23,6 +6,11 @@ declare module "@smapiot/piral-cloud-node" {
    */
   export function createServiceClient(options: CreateServiceClientOptions): FeedServiceApiClient;
 
+  /**
+   * The options for creating a new service client.
+   */
+  export type CreateServiceClientOptions = CreateServiceClientBaseOptions & CreateServiceClientApiKeyOptions;
+
   export class FeedServiceApiClient {
     constructor(private http: FetchClient, host?: string);
     getUrl(path: string): string;
@@ -56,7 +44,7 @@ declare module "@smapiot/piral-cloud-node" {
     doRevokeGeneralApiKey(id: string): Promise<unknown>;
     doRevokeApiKey(feed: string, id: string): Promise<unknown>;
     doRevokeFeedApiKey(feed: string, id: string): Promise<unknown>;
-    doDeletePilet(feed: string, id: string): Promise<unknown>;
+    doDeletePilet(feed: string, id: string, all?: boolean): Promise<unknown>;
     doDeleteRule(feed: string, id: string): Promise<unknown>;
     doUpdateRule(feed: string, id: string, content: RuleUpdateDetails): Promise<unknown>;
     doUpdatePilet(feed: string, id: string, content: PiletUpdateDetails): Promise<unknown>;
@@ -105,6 +93,23 @@ declare module "@smapiot/piral-cloud-node" {
     doDownloadFile(fileUrl: string, ac?: AbortController): Promise<Blob>;
   }
 
+  /**
+   * The basic / core options for creating a new service client.
+   */
+  export interface CreateServiceClientBaseOptions {
+    /**
+     * Defines the host to talk to. Set this if you want to communicate
+     * with your own feed service instance.
+     * @default https://feed.piral.cloud
+     */
+    host?: string;
+  }
+
+  /**
+   * The API key options for creating a new service client.
+   */
+  export type CreateServiceClientApiKeyOptions = CreateServiceClientSimpleApiKeyOptions | CreateServiceClientAdvancedApiKeyOptions;
+
   export interface FetchClient {
     getAuthorizationHeader(): Promise<string>;
     fetch(input: RequestInfo | URL, init?: RequestInit): Promise<Response>;
@@ -532,6 +537,32 @@ declare module "@smapiot/piral-cloud-node" {
     }>;
   }
 
+  /**
+   * The simple API key options for creating a new service client.
+   */
+  export interface CreateServiceClientSimpleApiKeyOptions {
+    /**
+     * Defines the API key to use for making the HTTP calls. Needs
+     * to be provided.
+     */
+    apiKey: string;
+  }
+
+  /**
+   * The advanced API key options for creating a new service client.
+   */
+  export interface CreateServiceClientAdvancedApiKeyOptions {
+    /**
+     * Defines the API key to use for making the HTTP calls. Needs
+     * to be provided.
+     */
+    resolveApiKey(): Promise<string>;
+    /**
+     * Defines the type of the resolved API key.
+     */
+    apiKeyType?: "basic" | "bearer" | "none";
+  }
+
   export interface ApiData<T> {
     items: Array<T>;
   }

package/lib/index.js

@@ -4588,8 +4588,8 @@ var FeedServiceApiClient = class {
   doRevokeFeedApiKey(feed, id) {
     return this.doDelete(`feed/${feed}/api-keys/${id}`);
   }
-  doDeletePilet(feed, id) {
-    return this.doDelete(`feed/${feed}/pilets/${id}`);
+  doDeletePilet(feed, id, all = false) {
+    return this.doDelete(`feed/${feed}/pilets/${id}?all=${all}`);
   }
   doDeleteRule(feed, id) {
     return this.doDelete(`feed/${feed}/rules/${id}`);
@@ -5974,6 +5974,39 @@ function fixResponseChunkedTransferBadEnding(request, errorCallback) {
   });
 }
 
+// src/utils.ts
+function createKeyHandler(apiKeyType) {
+  switch (apiKeyType) {
+    case "basic":
+      return (apiKey) => `Basic ${apiKey}`;
+    case "bearer":
+      return (apiKey) => `Bearer ${apiKey}`;
+    default:
+      return (apiKey) => apiKey;
+  }
+}
+function createAuthHead(options) {
+  if ("apiKey" in options) {
+    const { apiKey } = options;
+    if (typeof apiKey !== "string") {
+      throw new Error('The field "apiKey" has to be of type string.');
+    }
+    return () => Promise.resolve(`Basic ${apiKey}`);
+  } else if ("resolveApiKey" in options) {
+    const { resolveApiKey, apiKeyType = "basic" } = options;
+    if (typeof options.resolveApiKey !== "function") {
+      throw new Error('The field "resolveApiKey" has to be of type function.');
+    }
+    if (typeof apiKeyType !== "string") {
+      throw new Error('The field "apiKeyType" has to be of type string.');
+    }
+    const makeKey = createKeyHandler(apiKeyType);
+    return () => resolveApiKey().then(makeKey);
+  } else {
+    throw new Error('You must either specify "apikey" or "resolveApiKey".');
+  }
+}
+
 // src/index.ts
 function createServiceClient(options) {
   if (typeof options === "undefined") {
@@ -5982,20 +6015,16 @@ function createServiceClient(options) {
   if (typeof options !== "object") {
     throw new Error('The "options" have to be an object containing an "apiKey" field.');
   }
-  const { host = "https://feed.piral.cloud", apiKey } = options;
+  const { host = "https://feed.piral.cloud" } = options;
   if (typeof host !== "string") {
     throw new Error('The field "host" has to be of type string.');
   }
-  if (typeof apiKey !== "string") {
-    throw new Error('The field "apiKey" has to be of type string.');
-  }
+  const getAuthorizationHeader = createAuthHead(options);
   const http3 = {
     fetch,
     FormData,
     Headers,
-    getAuthorizationHeader() {
-      return Promise.resolve(`Basic ${apiKey}`);
-    }
+    getAuthorizationHeader
   };
   return new FeedServiceApiClient(http3, host);
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@smapiot/piral-cloud-node",
-  "version": "0.12.3-pre.20220810.1",
+  "version": "0.12.3",
   "description": "Piral Cloud: Node-usable API Client for the Piral Feed Service.",
   "author": {
     "name": "smapiot",