Merge pull request #1385 from balena-io/social_service_account

Add typings for the social_service_account resource
balena-io · Sep 26, 2023 · 019db36 · 019db36
2 parents 4e54ae8 + d8de677
commit 019db36
Show file tree

Hide file tree

Showing 6 changed files with 14 additions and 8 deletions.
diff --git a/package.json b/package.json
@@ -52,7 +52,7 @@
     "build": "npm run lint && npm run build-es2015 && npm run build-es2018 && npm run docs",
     "docs": "jsdoc2md --template doc/DOCUMENTATION.hbs --files \"es2015/**/!(balena-browser*.js)\" > DOCUMENTATION.md",
     "ci": "npm test && catch-uncommitted",
-    "lint": "balena-lint -e js -e ts --tests typing_tests typings src tests mjs_tests gulpfile.js",
+    "lint": "balena-lint -e js -e ts typing_tests typings src tests mjs_tests gulpfile.js",
     "lint:fix": "balena-lint -e js -e ts --fix typing_tests typings src tests mjs_tests gulpfile.js",
     "prepack": "npm run build",
     "watch": "npm run build && watch \"npm run lint\" \"src\" \"tests\"",
@@ -64,7 +64,7 @@
     "node": ">=16.0"
   },
   "devDependencies": {
-    "@balena/lint": "^7.0.1",
+    "@balena/lint": "^7.2.0",
     "@types/chai": "^4.3.0",
     "@types/chai-as-promised": "^7.1.4",
     "@types/lodash": "^4.14.195",

diff --git a/src/types/jwt.ts b/src/types/jwt.ts
@@ -20,10 +20,11 @@ export interface JWTUser {
 	twoFactorRequired?: boolean;
 	username: string;
 
+	/** @deprecated User the social_service_account resource */
 	social_service_account?: SocialServiceAccount[];
 }
 
-export interface SocialServiceAccount {
+interface SocialServiceAccount {
 	provider: string;
 	display_name: string;
 }
diff --git a/src/types/models.ts b/src/types/models.ts
@@ -60,6 +60,7 @@ export interface ResourceTypeMap {
 	service_environment_variable: ServiceEnvironmentVariable;
 	service_install: ServiceInstall;
 	service_instance: ServiceInstance;
+	social_service_account: SocialServiceAccount;
 	subscription: Subscription;
 	subscription_addon_discount: SubscriptionAddonDiscount;
 	subscription_prepaid_addon: SubscriptionPrepaidAddon;
@@ -406,7 +407,7 @@ export interface Device {
 	last_vpn_event: string;
 	latitude?: string;
 	local_id?: string;
-	location: string;
+	location?: string;
 	longitude?: string;
 	note: string;
 	os_variant?: string;
@@ -571,6 +572,14 @@ export interface SSHKey {
 	user: NavigationResource<User>;
 }
 
+export interface SocialServiceAccount {
+	// TODO: improve the custom pine client rypings to support resources w/o an id field
+	id: undefined;
+	belongs_to__user: NavigationResource<User>;
+	display_name: string | null;
+	provider: string;
+}
+
 export interface ImageInstall {
 	id: number;
 	download_progress: number | null;

diff --git a/tests/integration/setup.ts b/tests/integration/setup.ts
@@ -15,7 +15,6 @@ export const IS_BROWSER = typeof window !== 'undefined' && window !== null;
 export let balenaSdkExports: typeof BalenaSdk;
 export let sdkOpts: BalenaSdk.SdkOptions;
 if (IS_BROWSER) {
-	// eslint-disable-next-line @typescript-eslint/no-var-requires
 	require('js-polyfills/es6');
 	balenaSdkExports = window.balenaSdk;
 
@@ -26,7 +25,6 @@ if (IS_BROWSER) {
 			process.env.TEST_BUILDER_URL || apiUrl.replace('api.', 'builder.'),
 	};
 } else {
-	// eslint-disable-next-line @typescript-eslint/no-var-requires
 	balenaSdkExports = require('../..');
 	// eslint-disable-next-line @typescript-eslint/no-var-requires
 	const settings = require('balena-settings-client');

diff --git a/typing_tests/pine-params.ts b/typing_tests/pine-params.ts
@@ -1,4 +1,3 @@
-/* eslint-disable @typescript-eslint/no-unused-vars */
 /// <reference types="node" />
 import type * as BalenaSdk from '..';
 import type { AnyObject } from '../typings/utils';

diff --git a/typing_tests/pine-typed-result.ts b/typing_tests/pine-typed-result.ts
@@ -1,4 +1,3 @@
-/* eslint-disable @typescript-eslint/no-unused-vars */
 /// <reference types="node" />
 import type * as BalenaSdk from '..';
 import type { AnyObject } from '../typings/utils';