@homebridge-plugins/homebridge-august 3.4.1 → 3.4.2-beta.1

package/test/redact.test.ts

@@ -1,86 +0,0 @@
-import { describe, expect, it } from 'vitest'
-
-import { redactConfig } from '../src/redact.js'
-
-describe('redactConfig', () => {
-  it('masks a password but shows that one is set', () => {
-    const out = redactConfig({ password: 'hunter2' }) as Record<string, unknown>
-    expect(out.password).toBe('<redacted>')
-    expect(JSON.stringify(out)).not.toContain('hunter2')
-  })
-
-  it('distinguishes a blank value from a set one', () => {
-    expect((redactConfig({ password: '' }) as Record<string, unknown>).password).toBe('<empty>')
-    expect((redactConfig({ password: 'x' }) as Record<string, unknown>).password).toBe('<redacted>')
-  })
-
-  it('leaves an unset value alone so it reads as never configured', () => {
-    const out = redactConfig({ password: undefined, other: 1 }) as Record<string, unknown>
-    expect(out.password).toBeUndefined()
-    expect(out.other).toBe(1)
-  })
-
-  it('partially masks an email so the account stays identifiable', () => {
-    const out = redactConfig({ email: 'someone@example.com' }) as Record<string, unknown>
-    expect(out.email).toBe('s*****@example.com')
-  })
-
-  it('leaves a non-email string alone', () => {
-    expect((redactConfig({ email: 'notanemail' }) as Record<string, unknown>).email).toBe('notanemail')
-  })
-
-  it('masks an email-shaped value under any key name', () => {
-    const out = redactConfig({ augustId: 'someone@example.com', user: 'a@b.co' }) as Record<string, unknown>
-    expect(out.augustId).toBe('s*****@example.com')
-    expect(out.user).toBe('a*****@b.co')
-  })
-
-  it('redacts the roomba blid and nested device credentials', () => {
-    const out = redactConfig({
-      devices: [
-        { name: 'Living Room', blid: '1234567890', password: ':1:9999:abcdef' },
-      ],
-    }) as { devices: Record<string, unknown>[] }
-
-    expect(out.devices[0].name).toBe('Living Room')
-    expect(out.devices[0].blid).toBe('<redacted>')
-    expect(out.devices[0].password).toBe('<redacted>')
-    expect(JSON.stringify(out)).not.toContain('abcdef')
-  })
-
-  it('keeps non-sensitive settings readable', () => {
-    const out = redactConfig({
-      name: 'Roomba',
-      debug: true,
-      disableDiscovery: false,
-      mission: { ordered: 1, regions: [{ region_id: '3' }] },
-    }) as Record<string, any>
-
-    expect(out.name).toBe('Roomba')
-    expect(out.debug).toBe(true)
-    expect(out.disableDiscovery).toBe(false)
-    expect(out.mission.regions[0].region_id).toBe('3')
-  })
-
-  it('matches sensitive keys case-insensitively and by substring', () => {
-    const out = redactConfig({
-      apiKey: 'a',
-      API_KEY: 'b',
-      refreshToken: 'c',
-      clientSecret: 'd',
-      credentials: { user: 'e' },
-    }) as Record<string, unknown>
-
-    expect(out.apiKey).toBe('<redacted>')
-    expect(out.API_KEY).toBe('<redacted>')
-    expect(out.refreshToken).toBe('<redacted>')
-    expect(out.clientSecret).toBe('<redacted>')
-    expect(out.credentials).toBe('<redacted>')
-  })
-
-  it('handles arrays and primitives without throwing', () => {
-    expect(redactConfig([1, 'two', null])).toEqual([1, 'two', null])
-    expect(redactConfig(null)).toBeNull()
-    expect(redactConfig('plain')).toBe('plain')
-  })
-})

package/test/settings.test.ts

@@ -1,148 +0,0 @@
-import type { AugustPlatformConfig, credentials, device, options } from '../src/settings.js'
-
-import { describe, expect, it } from 'vitest'
-
-import { PLATFORM_NAME, PLUGIN_NAME } from '../src/settings.js'
-
-describe('settings', () => {
-  it('should have correct PLATFORM_NAME', () => {
-    expect(PLATFORM_NAME).toBe('August')
-  })
-
-  it('should have correct PLUGIN_NAME', () => {
-    expect(PLUGIN_NAME).toBe('homebridge-august')
-  })
-
-  it('should define AugustPlatformConfig interface', () => {
-    const config: AugustPlatformConfig = {
-      platform: 'August',
-      credentials: {
-        apiKey: 'test-api-key',
-        pnSubKey: 'test-pn-sub-key',
-        installId: 'test-install-id',
-        augustId: 'test-august-id',
-        password: 'test-password',
-        countryCode: 'test-country-code',
-      },
-      options: {
-        devices: [],
-        allowInvalidCharacters: true,
-        refreshRate: 60,
-        updateRate: 60,
-        pushRate: 60,
-        logging: 'debug',
-      },
-    }
-    expect(config.credentials?.apiKey).toBe('test-api-key')
-    expect(config.options?.refreshRate).toBe(60)
-  })
-
-  it('should define credentials interface', () => {
-    const creds: credentials = {
-      apiKey: 'test-api-key',
-      pnSubKey: 'test-pn-sub-key',
-      installId: 'test-install-id',
-      augustId: 'test-august-id',
-      password: 'test-password',
-      countryCode: 'test-country-code',
-    }
-    expect(creds.apiKey).toBe('test-api-key')
-    expect(creds.installId).toBe('test-install-id')
-  })
-
-  it('should define options interface', () => {
-    const opts: options = {
-      devices: [],
-      excludeLockIds: ['LOCK-ID-TO-EXCLUDE'],
-      allowInvalidCharacters: true,
-      refreshRate: 60,
-      updateRate: 60,
-      pushRate: 60,
-      logging: 'debug',
-    }
-    expect(opts.refreshRate).toBe(60)
-    expect(opts.logging).toBe('debug')
-    expect(opts.excludeLockIds).toContain('LOCK-ID-TO-EXCLUDE')
-  })
-
-  it('should support disableMatter option', () => {
-    const opts: options = {
-      devices: [],
-      disableMatter: true,
-    }
-    expect(opts.disableMatter).toBe(true)
-
-    const optsDefault: options = {
-      devices: [],
-    }
-    expect(optsDefault.disableMatter).toBeUndefined()
-  })
-
-  it('should define device interface', () => {
-    const dev: device = {
-      LockName: 'Test Lock',
-      Type: 1,
-      Created: '2023-01-01',
-      Updated: '2023-01-02',
-      LockId: 'test-lock-id',
-      HouseID: 'test-house-id',
-      HouseName: 'Test House',
-      Calibrated: true,
-      timeZone: 'UTC',
-      battery: 100,
-      batteryInfo: {
-        level: 100,
-        warningState: 'none',
-        infoUpdatedDate: '2023-01-01',
-        lastChangeDate: '2023-01-01',
-        lastChangeVoltage: 4.2,
-      },
-      doorStateOpenTimeout: 30,
-      hostLockInfo: {
-        serialNumber: 'test-serial-number',
-        manufacturer: 'Test Manufacturer',
-        productID: 1234,
-        productTypeID: 5678,
-      },
-      supportsEntryCodes: true,
-      remoteOperateSecret: 'test-secret',
-      skuNumber: 'test-sku',
-      macAddress: '00:11:22:33:44:55',
-      SerialNumber: 'test-serial-number',
-      LockStatus: {
-        status: 'locked',
-        dateTime: '2023-01-01T00:00:00Z',
-        isLockStatusChanged: true,
-        valid: true,
-        doorState: 'closed',
-      },
-      currentFirmwareVersion: '1.0.0',
-      homeKitEnabled: true,
-      zWaveEnabled: true,
-      isGalileo: false,
-      Bridge: {
-        _id: 'test-bridge-id',
-        mfgBridgeID: 'test-mfg-bridge-id',
-        deviceModel: 'test-model',
-        firmwareVersion: '1.0.0',
-        operative: true,
-        status: {
-          current: 'online',
-          lastOffline: '2023-01-01T00:00:00Z',
-          updated: '2023-01-01T00:00:00Z',
-          lastOnline: '2023-01-01T00:00:00Z',
-        },
-        locks: [],
-        hyperBridge: false,
-      },
-      parametersToSet: {},
-      users: {},
-      pubsubChannel: 'test-channel',
-      ruleHash: {},
-      cameras: [],
-      lockId: 'test-lock-id',
-    }
-    expect(dev.LockName).toBe('Test Lock')
-    expect(dev.battery).toBe(100)
-  })
-})