feat: added organizations to Schema CRUD commands

SmartThingsCommunity · Sep 28, 2023 · 60a9126 · 60a9126
1 parent 33f6476
commit 60a9126
Show file tree

Hide file tree

Showing 12 changed files with 53 additions and 39 deletions.
diff --git a/.changeset/early-houses-sip.md b/.changeset/early-houses-sip.md
@@ -0,0 +1,8 @@
+---
+"@smartthings/cli-lib": patch
+"@smartthings/cli-testlib": patch
+"@smartthings/plugin-cli-edge": patch
+"@smartthings/cli": patch
+---
+
+feat: added organizations to Schema CRUD commands
diff --git a/package-lock.json b/package-lock.json
diff --git a/packages/cli/package.json b/packages/cli/package.json
@@ -77,7 +77,7 @@
 		"@oclif/plugin-not-found": "^2.3.1",
 		"@oclif/plugin-plugins": "^2.1.0",
 		"@smartthings/cli-lib": "^2.2.1",
-		"@smartthings/core-sdk": "^8.0.0",
+		"@smartthings/core-sdk": "^8.0.1",
 		"@smartthings/plugin-cli-edge": "^3.3.0",
 		"inquirer": "^8.2.4",
 		"js-yaml": "^4.1.0",

diff --git a/packages/cli/src/__tests__/commands/schema.test.ts b/packages/cli/src/__tests__/commands/schema.test.ts
@@ -19,8 +19,8 @@ describe('SchemaCommand', () => {
 			expect.any(SchemaCommand),
 			expect.objectContaining({
 				tableFieldDefinitions: [
-					'appName', 'partnerName', 'endpointAppId', 'schemaType', 'hostingType',
-					'stClientId', 'oAuthAuthorizationUrl', 'oAuthTokenUrl', 'oAuthClientId',
+					'appName', 'partnerName', 'endpointAppId', 'organizationId', 'schemaType', 'hostingType',
+					('stClientId' as keyof SchemaApp), 'oAuthAuthorizationUrl', 'oAuthTokenUrl', 'oAuthClientId',
 					'oAuthClientSecret', 'icon', 'icon2x', 'icon3x',
 					{ prop: 'lambdaArn', skipEmpty: true },
 					{ prop: 'lambdaArnAP', skipEmpty: true },
@@ -31,7 +31,7 @@ describe('SchemaCommand', () => {
 				],
 				primaryKeyName: 'endpointAppId',
 				sortKeyName: 'appName',
-				listTableFieldDefinitions: ['appName', 'endpointAppId', 'hostingType'],
+				listTableFieldDefinitions: ['appName', 'endpointAppId', 'organizationId', 'hostingType'],
 			}),
 			'schemaAppId',
 			expect.any(Function),
@@ -58,7 +58,7 @@ describe('SchemaCommand', () => {
 		await expect(SchemaCommand.run(['--verbose'])).resolves.not.toThrow()
 
 		const config = (outputItemOrListMock.mock.calls[0][1] as TableCommonListOutputProducer<SchemaApp>)
-		const tableFieldDefinition = config.listTableFieldDefinitions[3] as { value: (input: SchemaApp) => string | undefined }
+		const tableFieldDefinition = config.listTableFieldDefinitions[4] as { value: (input: SchemaApp) => string | undefined }
 
 		expect(tableFieldDefinition).toBeObject()
 		const valueFunction = tableFieldDefinition.value

diff --git a/packages/cli/src/commands/schema.ts b/packages/cli/src/commands/schema.ts
@@ -2,16 +2,22 @@ import { Flags } from '@oclif/core'
 
 import { SchemaApp } from '@smartthings/core-sdk'
 
-import { APICommand, outputItemOrList, OutputItemOrListConfig } from '@smartthings/cli-lib'
+import {
+	allOrganizationsFlags,
+	APIOrganizationCommand,
+	outputItemOrList,
+	OutputItemOrListConfig,
+} from '@smartthings/cli-lib'
 
 
-export default class SchemaCommand extends APICommand<typeof SchemaCommand.flags> {
+export default class SchemaCommand extends APIOrganizationCommand<typeof SchemaCommand.flags> {
 	static description = 'list all ST Schema Apps currently available in a user account' +
 		this.apiDocsURL('getAppsByUserToken', 'getAppsByEndpointAppId')
 
 	static flags = {
-		...APICommand.flags,
+		...APIOrganizationCommand.flags,
 		...outputItemOrList.flags,
+		...allOrganizationsFlags,
 		verbose: Flags.boolean({
 			description: 'include ARN in output',
 			char: 'v',
@@ -26,7 +32,7 @@ export default class SchemaCommand extends APICommand<typeof SchemaCommand.flags
 	async run(): Promise<void> {
 		const config: OutputItemOrListConfig<SchemaApp> = {
 			tableFieldDefinitions: [
-				'appName', 'partnerName', 'endpointAppId', 'schemaType', 'hostingType',
+				'appName', 'partnerName', 'endpointAppId', 'organizationId', 'schemaType', 'hostingType',
 				// stClientId is missing from the docs
 				('stClientId' as keyof SchemaApp), 'oAuthAuthorizationUrl', 'oAuthTokenUrl', 'oAuthClientId',
 				'oAuthClientSecret', 'icon', 'icon2x', 'icon3x',
@@ -39,7 +45,7 @@ export default class SchemaCommand extends APICommand<typeof SchemaCommand.flags
 			],
 			primaryKeyName: 'endpointAppId',
 			sortKeyName: 'appName',
-			listTableFieldDefinitions: ['appName', 'endpointAppId', 'hostingType'],
+			listTableFieldDefinitions: ['appName', 'endpointAppId', 'organizationId', 'hostingType'],
 		}
 		if (this.flags.verbose) {
 			config.listTableFieldDefinitions.push({

diff --git a/packages/cli/src/commands/schema/create.ts b/packages/cli/src/commands/schema/create.ts
@@ -3,7 +3,7 @@ import { Flags } from '@oclif/core'
 import { SchemaAppRequest, SchemaCreateResponse } from '@smartthings/core-sdk'
 
 import {
-	APICommand,
+	APIOrganizationCommand,
 	inputAndOutputItem,
 	lambdaAuthFlags,
 	userInputProcessor,
@@ -13,12 +13,12 @@ import { addSchemaPermission } from '../../lib/aws-utils'
 import { SCHEMA_AWS_PRINCIPAL, getSchemaAppCreateFromUser } from '../../lib/commands/schema-util'
 
 
-export default class SchemaAppCreateCommand extends APICommand<typeof SchemaAppCreateCommand.flags> {
+export default class SchemaAppCreateCommand extends APIOrganizationCommand<typeof SchemaAppCreateCommand.flags> {
 	static description = 'create an ST Schema connector' +
 		this.apiDocsURL('postApps')
 
 	static flags = {
-		...APICommand.flags,
+		...APIOrganizationCommand.flags,
 		...inputAndOutputItem.flags,
 		authorize: Flags.boolean({
 			description: 'authorize connector\'s Lambda functions to be called by SmartThings',

diff --git a/packages/cli/src/commands/schema/delete.ts b/packages/cli/src/commands/schema/delete.ts
@@ -1,13 +1,13 @@
 import { SchemaApp } from '@smartthings/core-sdk'
 
-import { APICommand, selectFromList, SelectFromListConfig } from '@smartthings/cli-lib'
+import { APIOrganizationCommand, selectFromList, SelectFromListConfig } from '@smartthings/cli-lib'
 
 
-export default class SchemaAppDeleteCommand extends APICommand<typeof SchemaAppDeleteCommand.flags> {
+export default class SchemaAppDeleteCommand extends APIOrganizationCommand<typeof SchemaAppDeleteCommand.flags> {
 	static description = 'delete an ST Schema connector' +
 		this.apiDocsURL('deleteAppsByEndpointAppId')
 
-	static flags = APICommand.flags
+	static flags = APIOrganizationCommand.flags
 
 	static args = [{
 		name: 'id',

diff --git a/packages/cli/src/commands/schema/regenerate.ts b/packages/cli/src/commands/schema/regenerate.ts
@@ -1,14 +1,14 @@
-import { APICommand, selectFromList, outputItem, SelectFromListConfig } from '@smartthings/cli-lib'
+import { APIOrganizationCommand, selectFromList, outputItem, SelectFromListConfig } from '@smartthings/cli-lib'
 import { SchemaApp } from '@smartthings/core-sdk'
 
 
-export default class SchemaAppRegenerateCommand extends APICommand<typeof SchemaAppRegenerateCommand.flags> {
+export default class SchemaAppRegenerateCommand extends APIOrganizationCommand<typeof SchemaAppRegenerateCommand.flags> {
 	static description = 'regenerate the clientId and clientSecret of the ST Schema connector\n' +
 		'NOTE: The previous values will be invalidated, which may affect existing installations.' +
 		this.apiDocsURL('generateStOauthCredentials')
 
 	static flags = {
-		...APICommand.flags,
+		...APIOrganizationCommand.flags,
 		...outputItem.flags,
 	}
 

diff --git a/packages/cli/src/commands/schema/update.ts b/packages/cli/src/commands/schema/update.ts
@@ -2,18 +2,18 @@ import { Flags, Errors } from '@oclif/core'
 
 import { SchemaApp, SchemaAppRequest } from '@smartthings/core-sdk'
 
-import { APICommand, inputItem, selectFromList, lambdaAuthFlags, SelectFromListConfig, userInputProcessor } from '@smartthings/cli-lib'
+import { APIOrganizationCommand, inputItem, selectFromList, lambdaAuthFlags, SelectFromListConfig, userInputProcessor } from '@smartthings/cli-lib'
 
 import { addSchemaPermission } from '../../lib/aws-utils'
 import { getSchemaAppUpdateFromUser } from '../../lib/commands/schema-util'
 
 
-export default class SchemaUpdateCommand extends APICommand<typeof SchemaUpdateCommand.flags> {
+export default class SchemaUpdateCommand extends APIOrganizationCommand<typeof SchemaUpdateCommand.flags> {
 	static description = 'update an ST Schema connector' +
 		this.apiDocsURL('putAppsByEndpointAppId')
 
 	static flags = {
-		...APICommand.flags,
+		...APIOrganizationCommand.flags,
 		...inputItem.flags,
 		// eslint-disable-next-line @typescript-eslint/naming-convention
 		'dry-run': Flags.boolean({

diff --git a/packages/edge/package.json b/packages/edge/package.json
@@ -48,7 +48,7 @@
 		"@log4js-node/log4js-api": "^1.0.2",
 		"@oclif/core": "^1.16.3",
 		"@smartthings/cli-lib": "^2.2.1",
-		"@smartthings/core-sdk": "^8.0.0",
+		"@smartthings/core-sdk": "^8.0.1",
 		"axios": "^1.5.0",
 		"inquirer": "^8.2.4",
 		"js-yaml": "^4.1.0",

diff --git a/packages/lib/package.json b/packages/lib/package.json
@@ -30,7 +30,7 @@
 	"dependencies": {
 		"@log4js-node/log4js-api": "^1.0.2",
 		"@oclif/core": "^1.16.3",
-		"@smartthings/core-sdk": "^8.0.0",
+		"@smartthings/core-sdk": "^8.0.1",
 		"@types/eventsource": "^1.1.9",
 		"axios": "^1.5.0",
 		"chalk": "^4.1.2",

diff --git a/packages/testlib/package.json b/packages/testlib/package.json
@@ -29,7 +29,7 @@
 	},
 	"dependencies": {
 		"@smartthings/cli-lib": "^2.1.1",
-		"@smartthings/core-sdk": "^8.0.0"
+		"@smartthings/core-sdk": "^8.0.1"
 	},
 	"devDependencies": {
 		"@types/jest": "^28.1.5",