balena-sdk 16.9.1 → 16.9.2

package/es2018/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/es2018/index.js

@@ -84,7 +84,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');
     /**
@@ -126,7 +126,7 @@ const getSdk = function ($opts) {
     }
     const auth = new BalenaAuth(opts);
     const request = getRequest({ ...opts, auth });
-    const pine = new BalenaPine({}, { ...opts, auth, request });
+    const pine = createPinejsClient({}, { ...opts, auth, request });
     const pubsub = new PubSub();
     const sdk = {};
     const deps = {
@@ -244,7 +244,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/es2018/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/es2018/pine.js

@@ -0,0 +1,73 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.createPinejsClient = void 0;
+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({
+            ...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.
+     */
+    async _request(options) {
+        const { apiKey, apiUrl, auth, request } = this.backendParams;
+        const hasKey = await auth.hasKey();
+        const authenticated = hasKey || (apiKey != null && apiKey.length > 0);
+        options = {
+            apiKey,
+            baseUrl: apiUrl,
+            sendToken: authenticated && !options.anonymous,
+            ...options,
+        };
+        try {
+            const { body } = await 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/es2018/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;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "balena-sdk",
-  "version": "16.9.1",
+  "version": "16.9.2",
   "description": "The Balena JavaScript SDK",
   "main": "index.js",
   "types": "index.d.ts",
@@ -36,7 +36,7 @@
     "test": "npm run build && npm run test:all",
     "test:all": "npm run test:ts-compatibility && npm run test:dev && npm run test:ts-js && npm run test:typings && npm run test:node && npm run test:browser",
     "test:node": "gulp test",
-    "test:browser": "karma start",
+    "test:browser": "mockttp -c karma start",
     "test:dev": "tsc --noEmit --project ./tsconfig.dev.json",
     "test:ts-js": "tsc --noEmit --project ./tsconfig.js.json",
     "test:ts-compatibility": "npx typescript@~4.5.2 --noEmit --project ./tsconfig.dist.json",
@@ -83,10 +83,12 @@
     "lint-staged": "^10.5.4",
     "mocha": "^3.5.3",
     "mocha.parallel": "^0.15.6",
+    "mockttp": "^0.9.1",
     "rimraf": "^3.0.2",
     "rindle": "^1.3.6",
     "sinon": "^12.0.1",
     "superagent": "^3.8.3",
+    "temp": "^0.8.4",
     "tmp": "^0.0.31",
     "ts-node": "^7.0.1",
     "ts-toolbelt": "^6.15.5",
@@ -106,7 +108,6 @@
     "balena-auth": "^4.1.0",
     "balena-errors": "^4.7.1",
     "balena-hup-action-utils": "~4.1.0",
-    "balena-pine": "^12.4.0",
     "balena-register-device": "^7.1.0",
     "balena-request": "^11.5.0",
     "balena-semver": "^2.3.0",
@@ -115,9 +116,10 @@
     "memoizee": "^0.4.15",
     "moment": "^2.29.1",
     "ndjson": "^2.0.0",
+    "pinejs-client-core": "^6.9.6",
     "tslib": "^2.1.0"
   },
   "versionist": {
-    "publishedAt": "2021-12-28T14:18:08.803Z"
+    "publishedAt": "2021-12-28T17:20:53.079Z"
   }
 }

package/typings/pinejs-client-core.d.ts

@@ -455,6 +455,7 @@ export interface SubscribeParamsWithId<T> extends ParamsObjWithId<T> {
 }
 
 export interface Pine<ResourceTypeMap extends {} = {}> {
+	apiPrefix: string;
 	delete<T>(params: ParamsObjWithId<T> | ParamsObjWithFilter<T>): Promise<'OK'>;
 	// Fully typed result overloads
 	get<

package/typings/balena-pine.d.ts

@@ -1,9 +0,0 @@
-import type * as PineClient from './pinejs-client-core';
-
-export type Pine<ResourceTypeMap> = PineClient.Pine<ResourceTypeMap>;
-/**
- * A variant that makes $select mandatory, helping to create
- * requests that explicitly fetch only what your code needs.
- */
-export type PineStrict<ResourceTypeMap> =
-	PineClient.PineStrict<ResourceTypeMap>;