chore(types): start comprehensive typing

charliegroll · charliegroll · commit f1f2c25b0d32 · 2024-01-11T10:26:45.000-07:00
diff --git a/src/main.test.ts b/src/main.test.ts
@@ -781,7 +781,9 @@ describe('set', () => {
         siteID,
       })
 
+      // @ts-expect-error The `key` paramater is typed to not allow this
       expect(async () => await blobs.set('', 'value')).rejects.toThrowError('Blob key must not be empty.')
+      // @ts-expect-error The `key` paramater is typed to not allow this
       expect(async () => await blobs.set('/key', 'value')).rejects.toThrowError(
         'Blob key must not start with forward slash (/).',
       )
diff --git a/src/store.ts b/src/store.ts
@@ -19,6 +19,7 @@ interface NamedStoreOptions extends BaseStoreOptions {
 }
 
 export type StoreOptions = DeployStoreOptions | NamedStoreOptions
+type Key<T> = T extends string ? (T extends '' | `/${string}` ? never : T) : never
 
 export interface GetWithMetadataOptions {
   etag?: string
@@ -257,7 +258,10 @@ export class Store {
     )
   }
 
-  async set(key: string, data: BlobInput, { metadata }: SetOptions = {}) {
+  async set(key: `Key must not be empty and must not start with /`, data: BlobInput, opts?: SetOptions): Promise<void>
+  async set<K>(key: Key<K>, data: BlobInput): Promise<void>
+  async set<K>(key: Key<K>, data: BlobInput, { metadata }: SetOptions): Promise<void>
+  async set<K>(key: Key<K>, data: BlobInput, { metadata }: SetOptions = {}) {
     Store.validateKey(key)
 
     const res = await this.client.makeRequest({
@@ -273,7 +277,7 @@ export class Store {
     }
   }
 
-  async setJSON(key: string, data: unknown, { metadata }: SetOptions = {}) {
+  async setJSON<K>(key: Key<K>, data: unknown, { metadata }: SetOptions = {}) {
     Store.validateKey(key)
 
     const payload = JSON.stringify(data)
@@ -306,7 +310,7 @@ export class Store {
     }
   }
 
-  private static validateKey(key: string) {
+  private static validateKey<K>(key: Key<K>) {
     if (key === '') {
       throw new Error('Blob key must not be empty.')
     }

Original file line number	Diff line number	Diff line change
`@@ -781,7 +781,9 @@ describe('set', () => {`
`781`	`781`	`siteID,`
`782`	`782`	`})`
`783`	`783`
	`784`	+ // @ts-expect-error The `key` paramater is typed to not allow this
`784`	`785`	`expect(async () => await blobs.set('', 'value')).rejects.toThrowError('Blob key must not be empty.')`
	`786`	+ // @ts-expect-error The `key` paramater is typed to not allow this
`785`	`787`	`expect(async () => await blobs.set('/key', 'value')).rejects.toThrowError(`
`786`	`788`	`'Blob key must not start with forward slash (/).',`
`787`	`789`	`)`
Original file line number	Diff line number	Diff line change
`@@ -19,6 +19,7 @@ interface NamedStoreOptions extends BaseStoreOptions {`
`19`	`19`	`}`
`20`	`20`
`21`	`21`	`export type StoreOptions = DeployStoreOptions \| NamedStoreOptions`
	`22`	+type Key<T> = T extends string ? (T extends '' \| `/${string}` ? never : T) : never
`22`	`23`
`23`	`24`	`export interface GetWithMetadataOptions {`
`24`	`25`	`etag?: string`
`@@ -257,7 +258,10 @@ export class Store {`
`257`	`258`	`)`
`258`	`259`	`}`
`259`	`260`
`260`		`- async set(key: string, data: BlobInput, { metadata }: SetOptions = {}) {`
	`261`	+ async set(key: `Key must not be empty and must not start with /`, data: BlobInput, opts?: SetOptions): Promise<void>
	`262`	`+ async set<K>(key: Key<K>, data: BlobInput): Promise<void>`
	`263`	`+ async set<K>(key: Key<K>, data: BlobInput, { metadata }: SetOptions): Promise<void>`
	`264`	`+ async set<K>(key: Key<K>, data: BlobInput, { metadata }: SetOptions = {}) {`
`261`	`265`	`Store.validateKey(key)`
`262`	`266`
`263`	`267`	`const res = await this.client.makeRequest({`
`@@ -273,7 +277,7 @@ export class Store {`
`273`	`277`	`}`
`274`	`278`	`}`
`275`	`279`
`276`		`- async setJSON(key: string, data: unknown, { metadata }: SetOptions = {}) {`
	`280`	`+ async setJSON<K>(key: Key<K>, data: unknown, { metadata }: SetOptions = {}) {`
`277`	`281`	`Store.validateKey(key)`
`278`	`282`
`279`	`283`	`const payload = JSON.stringify(data)`
`@@ -306,7 +310,7 @@ export class Store {`
`306`	`310`	`}`
`307`	`311`	`}`
`308`	`312`
`309`		`- private static validateKey(key: string) {`
	`313`	`+ private static validateKey<K>(key: Key<K>) {`
`310`	`314`	`if (key === '') {`
`311`	`315`	`throw new Error('Blob key must not be empty.')`
`312`	`316`	`}`