[BUG]: InstallationUnsuspendEvent.installation is never

[chris-feist]

What happened?

TypeScript converts InstallationUnsuspendEvent.installation to type never because it has troubles with the union type

https://github.com/octokit/webhooks/blob/main/payload-types/schema.d.ts#L3516

I'd recommend removing the union since suspended_by and suspended_at can already be null. Alternatively the fields could be omitted.

  installation: Installation;
  
// or

  installation: Omit<Installation, 'suspended_by' | 'suspended_at'> & {
    suspended_by: null;
    suspended_at: null;
  };

Versions

@octokit/webhooks-types: 6.11.0
typescript: 4.1.3

Relevant log output

The intersection 'Installation & { suspended_by: null; suspended_at: null; }' was reduced to 'never' because property 'suspended_at' has conflicting types in some constituents.

Code of Conduct

• I agree to follow this project's Code of Conduct

[wolfy1339]

Can you share your tsconfig?

If you don't have strict enabled, it resolves to never

[chris-feist]

I have the default setting for strict. Here is my config:

// tsconfig.json
{
  "extends": "./tsconfig.paths.json",
  "compilerOptions": {
    "lib": ["ESNext"],
    "moduleResolution": "node",
    "removeComments": true,
    "sourceMap": true,
    "target": "ESNext",
    "outDir": "lib",
    "skipLibCheck": true
  },
  "include": ["src/**/*.ts", "serverless.ts"],
  "exclude": [
    "node_modules/**/*",
    ".serverless/**/*",
    ".webpack/**/*",
    "_warmup/**/*",
    ".vscode/**/*"
  ],
  "ts-node": {
    "require": ["tsconfig-paths/register"]
  }
}

// tsconfig.paths.json
{
  "compilerOptions": {
    "baseUrl": ".",
    "paths": {
      "@functions/*": ["src/functions/*"],
      "@languages/*": ["src/languages/*"],
      "@src/*": ["src/*"],
      "@utils/*": ["src/utils/*"]
    }
  }
}

[wolfy1339]

At the very minimum, we require that the strictNullChecks be enabled.

The default value for strict is false (which includes strictNullChecks)

[chris-feist]

Is there a reason for not updating the type to support both tsconfig options?

[wolfy1339]

Even with that change, you still need strictNullChecks in order to use the types.

[wolfy1339]

See #395 also for more info

[chris-feist]

While I can confirm that strictNullChecks: true does remove the error, my suggestions also remove the error. If you wanted to force suspended_at and suspended_by to null, then the Omit approach I suggested would be the best path forward. I put together this example:

https://stackblitz.com/edit/typescript-4gwo1b?file=index.ts

[wolfy1339]

That isn't a viable solution. The types are autogenerated from our JSON schema

[chris-feist]

Okay, makes sense then