balena-sdk 16.9.1 → 16.9.2

package/es2015/index.d.ts

@@ -1,9 +1,7 @@
 /// <reference types="memoizee" />
-import type { Pine as PineBase, PineStrict as PineStrictBase } from '../typings/balena-pine';
+import type { Pine } from './pine';
 import type { BalenaRequest, Interceptor } from 'balena-request';
-import type { ResourceTypeMap } from './types/models';
-export declare type Pine = PineBase<ResourceTypeMap>;
-export declare type PineStrict = PineStrictBase<ResourceTypeMap>;
+export type { Pine, PineStrict } from './pine';
 export * from './types/models';
 export * from './types/jwt';
 export * from './types/contract';
@@ -404,7 +402,10 @@ declare const sdkTemplate: {
                 getAllByService: (parentParam: string | number, options?: import("../typings/pinejs-client-core").ODataOptions<import("./types/models").ServiceEnvironmentVariable> | undefined) => Promise<import("./types/models").ServiceEnvironmentVariable[]>;
                 getAllByApplication(slugOrId: string | number, options?: import("../typings/pinejs-client-core").ODataOptions<import("./types/models").ServiceEnvironmentVariable>): Promise<import("./types/models").ServiceEnvironmentVariable[]>;
                 get: (parentParam: string | number, key: string) => Promise<string | undefined>;
-                set: (parentParam: string | number, key: string, value: string) => Promise<void>;
+                set: (parentParam: string | number, key: string, value: string) => Promise<void>; /**
+                 * @namespace settings
+                 * @memberof balena
+                 */
                 remove: (parentParam: string | number, key: string) => Promise<void>;
             };
         };

package/es2015/index.js

@@ -79,7 +79,7 @@ const getSdk = function ($opts) {
     const { getRequest } = require('balena-request');
     const BalenaAuth = require('balena-auth')
         .default;
-    const { BalenaPine } = require('balena-pine');
+    const { createPinejsClient } = require('./pine');
     const errors = require('balena-errors');
     const { PubSub } = require('./util/pubsub');
     /**
@@ -121,7 +121,7 @@ const getSdk = function ($opts) {
     }
     const auth = new BalenaAuth(opts);
     const request = getRequest(Object.assign(Object.assign({}, opts), { auth }));
-    const pine = new BalenaPine({}, Object.assign(Object.assign({}, opts), { auth, request }));
+    const pine = createPinejsClient({}, Object.assign(Object.assign({}, opts), { auth, request }));
     const pubsub = new PubSub();
     const sdk = {};
     const deps = {
@@ -239,7 +239,7 @@ const getSdk = function ($opts) {
      * @memberof balena
      *
      * @description
-     * The balena-pine instance used internally. This should not be necessary
+     * The pinejs-client instance used internally. This should not be necessary
      * in normal usage, but can be useful if you want to directly make pine
      * queries to the api for some resource that isn't directly supported
      * in the SDK.

package/es2015/pine.d.ts

@@ -0,0 +1,22 @@
+import { AnyObject, Params } from 'pinejs-client-core';
+import type * as PineClient from '../typings/pinejs-client-core';
+import type { ResourceTypeMap } from './types/models';
+interface BackendParams {
+    apiUrl: string;
+    apiVersion: string;
+    apiKey?: string;
+    request: {
+        send: (options: AnyObject) => Promise<{
+            body: any;
+        }>;
+    };
+    auth: import('balena-auth').default;
+}
+export declare type Pine = PineClient.Pine<ResourceTypeMap>;
+/**
+ * A variant that makes $select mandatory, helping to create
+ * requests that explicitly fetch only what your code needs.
+ */
+export declare type PineStrict = PineClient.PineStrict<ResourceTypeMap>;
+export declare const createPinejsClient: (params: Params, backendParams: BackendParams) => Pine;
+export {};

package/es2015/pine.js

@@ -0,0 +1,68 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.createPinejsClient = void 0;
+const tslib_1 = require("tslib");
+const url = require("url");
+const errors = require("balena-errors");
+const pinejs_client_core_1 = require("pinejs-client-core");
+/**
+ * @class
+ * @classdesc A PineJS Client subclass to communicate with balena.
+ * @private
+ *
+ * @description
+ * This subclass makes use of the [balena-request](https://github.com/balena-io-modules/balena-request) project.
+ */
+class PinejsClient extends pinejs_client_core_1.PinejsClientCore {
+    constructor(params, backendParams) {
+        super(Object.assign(Object.assign({}, params), { apiPrefix: url.resolve(backendParams.apiUrl, `/${backendParams.apiVersion}/`) }));
+        this.backendParams = backendParams;
+        this.backendParams = backendParams;
+        this.API_URL = backendParams.apiUrl;
+        this.API_VERSION = backendParams.apiVersion;
+    }
+    /**
+     * @summary Perform a network request to balena.
+     * @method
+     * @private
+     *
+     * @param {Object} options - request options
+     * @returns {Promise<*>} response body
+     *
+     * @todo Implement caching support.
+     */
+    _request(options) {
+        return (0, tslib_1.__awaiter)(this, void 0, void 0, function* () {
+            const { apiKey, apiUrl, auth, request } = this.backendParams;
+            const hasKey = yield auth.hasKey();
+            const authenticated = hasKey || (apiKey != null && apiKey.length > 0);
+            options = Object.assign({ apiKey, baseUrl: apiUrl, sendToken: authenticated && !options.anonymous }, options);
+            try {
+                const { body } = yield request.send(options);
+                return body;
+            }
+            catch (err) {
+                if (err.statusCode !== 401) {
+                    throw err;
+                }
+                // Always return the API error when the anonymous flag is used.
+                if (options.anonymous) {
+                    throw err;
+                }
+                // We want to allow unauthenticated users to make requests
+                // to public resources, but still reject with a NotLoggedIn
+                // error if the response ends up being a 401.
+                if (!authenticated) {
+                    throw new errors.BalenaNotLoggedIn();
+                }
+                throw err;
+            }
+        });
+    }
+}
+const createPinejsClient = (...args) => {
+    const pine = new PinejsClient(...args);
+    // @ts-expect-error
+    return pine;
+};
+exports.createPinejsClient = createPinejsClient;

package/es2015/util/sdk-version.js

@@ -6,5 +6,5 @@ Object.defineProperty(exports, "__esModule", { value: true });
 // being embedded in the dist of the consumer project
 // which we want to avoid, both b/c of the dist size increase &
 // the security concerns of including the versions of the dependencies
-const sdkVersion = '16.9.1';
+const sdkVersion = '16.9.2';
 exports.default = sdkVersion;