fix(typescript): avoid object type (#36)

Author: kschaefe

.github/workflows/test.yml

@@ -24,3 +24,4 @@ jobs:
           check-latest: true
       - run: npm clean-install
       - run: npm run test
+      - run: npm run test-types

package-lock.json

@@ -29,6 +29,7 @@
   ],
   "scripts": {
     "test": "ava",
+    "test-types": "tsc --project types",
     "watch": "ava --watch"
   },
   "ava": {
@@ -39,7 +40,8 @@
   "devDependencies": {
     "@types/node": "^16.4.0",
     "ava": "^3.15.0",
-    "sinon": "^11.1.2"
+    "sinon": "^11.1.2",
+    "typescript": "^3.6.0"
   },
   "engines": {
     "node": ">=16.0.0"

package.json

@@ -5,7 +5,7 @@ export interface ProduceOptions {
   assertion?: string | Buffer
   audience?: string
   expiresIn?: string
-  footer?: object | string | Buffer
+  footer?: Record<PropertyKey, unknown> | string | Buffer
   iat?: boolean
   issuer?: string
   jti?: string
@@ -30,7 +30,7 @@ export interface ConsumeOptions<TComplete extends boolean> {
 }
 export interface CompleteResult {
   footer?: Buffer
-  payload: object
+  payload: Record<string, unknown>
   purpose: 'local' | 'public'
   version: string
 }
@@ -47,7 +47,7 @@ export interface CompleteResultBuffer {
 }
 export interface DecodeResult {
   footer?: Buffer
-  payload?: object
+  payload?: Record<string, unknown>
   purpose: 'local' | 'public'
   version: string
 }
@@ -60,20 +60,20 @@ export interface DecodeResultBuffer {
 export function decode(token: string): DecodeResult
 export namespace V1 {
   function sign(
-    payload: object | Buffer,
+    payload: Record<PropertyKey, unknown> | Buffer,
     key: KeyObject | Buffer | PrivateKeyInput | JsonWebKeyInput | string,
     options?: Omit<ProduceOptions, 'assertion'>,
   ): Promise<string>
   function encrypt(
-    payload: object | Buffer,
+    payload: Record<PropertyKey, unknown> | Buffer,
     key: KeyObject | Buffer | string,
     options?: Omit<ProduceOptions, 'assertion'>,
   ): Promise<string>
   function verify(
     token: string,
     key: KeyObject | Buffer | PublicKeyInput | JsonWebKeyInput | string,
     options?: Omit<ConsumeOptions<false>, 'assertion'>,
-  ): Promise<object>
+  ): Promise<Record<string, unknown>>
   function verify(
     token: string,
     key: KeyObject | Buffer | PublicKeyInput | JsonWebKeyInput | string,
@@ -93,7 +93,7 @@ export namespace V1 {
     token: string,
     key: KeyObject | Buffer | string,
     options?: Omit<ConsumeOptions<false>, 'assertion'>,
-  ): Promise<object>
+  ): Promise<Record<string, unknown>>
   function decrypt(
     token: string,
     key: KeyObject | Buffer | string,
@@ -116,15 +116,15 @@ export namespace V1 {
 }
 export namespace V2 {
   function sign(
-    payload: object | Buffer,
+    payload: Record<PropertyKey, unknown> | Buffer,
     key: KeyObject | Buffer | PrivateKeyInput | JsonWebKeyInput | string,
     options?: Omit<ProduceOptions, 'assertion'>,
   ): Promise<string>
   function verify(
     token: string,
     key: KeyObject | Buffer | PublicKeyInput | JsonWebKeyInput | string,
     options?: Omit<ConsumeOptions<false>, 'assertion'>,
-  ): Promise<object>
+  ): Promise<Record<string, unknown>>
   function verify(
     token: string,
     key: KeyObject | Buffer | PublicKeyInput | JsonWebKeyInput | string,
@@ -148,20 +148,20 @@ export namespace V2 {
 }
 export namespace V3 {
   function sign(
-    payload: object | Buffer,
+    payload: Record<PropertyKey, unknown> | Buffer,
     key: KeyObject | Buffer | PrivateKeyInput | JsonWebKeyInput | string,
     options?: ProduceOptions,
   ): Promise<string>
   function encrypt(
-    payload: object | Buffer,
+    payload: Record<PropertyKey, unknown> | Buffer,
     key: KeyObject | Buffer | string,
     options?: ProduceOptions,
   ): Promise<string>
   function verify(
     token: string,
     key: KeyObject | Buffer | PublicKeyInput | JsonWebKeyInput | string,
     options?: ConsumeOptions<false>,
-  ): Promise<object>
+  ): Promise<Record<string, unknown>>
   function verify(
     token: string,
     key: KeyObject | Buffer | PublicKeyInput | JsonWebKeyInput | string,
@@ -181,7 +181,7 @@ export namespace V3 {
     token: string,
     key: KeyObject | Buffer | string,
     options?: ConsumeOptions<false>,
-  ): Promise<object>
+  ): Promise<Record<string, unknown>>
   function decrypt(
     token: string,
     key: KeyObject | Buffer | string,
@@ -206,15 +206,15 @@ export namespace V3 {
 }
 export namespace V4 {
   function sign(
-    payload: object | Buffer,
+    payload: Record<PropertyKey, unknown> | Buffer,
     key: KeyObject | Buffer | PrivateKeyInput | JsonWebKeyInput | string,
     options?: ProduceOptions,
   ): Promise<string>
   function verify(
     token: string,
     key: KeyObject | Buffer | PublicKeyInput | JsonWebKeyInput | string,
     options?: ConsumeOptions<false>,
-  ): Promise<object>
+  ): Promise<Record<string, unknown>>
   function verify(
     token: string,
     key: KeyObject | Buffer | PublicKeyInput | JsonWebKeyInput | string,

types/index.d.ts

@@ -121,7 +121,7 @@ import * as paseto from './index.d'
     a.purpose
     a.version
 
-    await paseto.V1.decrypt(token, key, {
+    const b = await paseto.V1.decrypt(token, key, {
       audience: 'string',
       clockTolerance: '60s',
       ignoreExp: true,
@@ -132,5 +132,7 @@ import * as paseto from './index.d'
       now: new Date(),
       subject: 'string',
     })
+
+    b['arbitrary claim']
   }
 })()