Skip to content

Commit a05a8c8

Browse files
benjamincanacbenjamincanac
committed
feat(composables)!: remove deprecated wrappers
1 parent e5b8820 commit a05a8c8

File tree

5 files changed

+179
-207
lines changed

5 files changed

+179
-207
lines changed

‎src/runtime/composables-v3/useStrapi.ts

+95-3
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,5 @@
11
import type { Strapi3RequestParams } from '../types/v3'
2-
// @ts-expect-error this import is not available in stubbed version
3-
import { useStrapi3 } from '#imports'
2+
import { useStrapiClient } from '#imports'
43

54
interface StrapiV3Client<T> {
65
count(contentType: string, params?: Strapi3RequestParams): Promise<number>
@@ -12,5 +11,98 @@ interface StrapiV3Client<T> {
1211
}
1312

1413
export const useStrapi = <T>(): StrapiV3Client<T> => {
15-
return useStrapi3()
14+
const client = useStrapiClient()
15+
16+
/**
17+
* Count {content-type} entries
18+
*
19+
* @param {string} contentType - Content type's name pluralized
20+
* @param {Strapi3RequestParams} [params] - Query parameters
21+
* @returns Promise<number>
22+
*/
23+
const count = (contentType: string, params?: Strapi3RequestParams): Promise<number> => {
24+
return client(`/${contentType}/count`, { method: 'GET', params })
25+
}
26+
27+
/**
28+
* Get a list of {content-type} entries
29+
*
30+
* @param {string} contentType - Content type's name pluralized
31+
* @param {Strapi3RequestParams} [params] - Query parameters
32+
* @returns Promise<T>
33+
*/
34+
const find = <T>(contentType: string, params?: Strapi3RequestParams): Promise<T> => {
35+
return client(`/${contentType}`, { method: 'GET', params })
36+
}
37+
38+
/**
39+
* Get a specific {content-type} entry
40+
*
41+
* @param {string} contentType - Content type's name pluralized
42+
* @param {string|number} id - ID of entry
43+
* @param {Strapi3RequestParams} [params] - Query parameters
44+
* @returns Promise<T>
45+
*/
46+
const findOne = <T>(contentType: string, id?: string | number | Strapi3RequestParams, params?: Strapi3RequestParams): Promise<T> => {
47+
if (typeof id === 'object') {
48+
params = id
49+
id = undefined
50+
}
51+
52+
const path = [contentType, id].filter(Boolean).join('/')
53+
54+
return client(path, { method: 'GET', params })
55+
}
56+
57+
/**
58+
* Create a {content-type} entry
59+
*
60+
* @param {string} contentType - Content type's name pluralized
61+
* @param {Record<string, any>} data - Form data
62+
* @returns Promise<T>
63+
*/
64+
const create = <T>(contentType: string, data: Partial<T>): Promise<T> => {
65+
return client(`/${contentType}`, { method: 'POST', body: data })
66+
}
67+
68+
/**
69+
* Update an entry
70+
*
71+
* @param {string} contentType - Content type's name pluralized
72+
* @param {string|number} id - ID of entry to be updated
73+
* @param {Record<string, any>} data - Form data
74+
* @returns Promise<T>
75+
*/
76+
const update = <T>(contentType: string, id: string | number | Partial<T>, data?: Partial<T>): Promise<T> => {
77+
if (typeof id === 'object') {
78+
data = id
79+
id = undefined
80+
}
81+
82+
const path = [contentType, id].filter(Boolean).join('/')
83+
84+
return client(path, { method: 'PUT', body: data })
85+
}
86+
87+
/**
88+
* Delete an entry
89+
*
90+
* @param {string} contentType - Content type's name pluralized
91+
* @param {string|number} id - ID of entry to be deleted
92+
* @returns Promise<T>
93+
*/
94+
const _delete = <T>(contentType: string, id?: string | number): Promise<T> => {
95+
const path = [contentType, id].filter(Boolean).join('/')
96+
97+
return client(path, { method: 'DELETE' })
98+
}
99+
100+
return {
101+
count,
102+
find,
103+
findOne,
104+
create,
105+
update,
106+
delete: _delete
107+
}
16108
}

‎src/runtime/composables-v3/useStrapi3.ts

-106
This file was deleted.

‎src/runtime/composables-v4/useStrapi.ts

+84-2
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
1+
import type { FetchOptions } from 'ofetch'
12
import type { Strapi4ResponseSingle, Strapi4RequestParams, Strapi4ResponseMany } from '../types/v4'
2-
import { useStrapi4 } from '#imports'
3+
import { useStrapiClient } from '#imports'
34

45
interface StrapiV4Client<T> {
56
find<F = T>(contentType: string, params?: Strapi4RequestParams): Promise<Strapi4ResponseMany<F>>
@@ -10,5 +11,86 @@ interface StrapiV4Client<T> {
1011
}
1112

1213
export const useStrapi = <T>(): StrapiV4Client<T> => {
13-
return useStrapi4() as StrapiV4Client<T>
14+
const client = useStrapiClient()
15+
16+
/**
17+
* Get a list of {content-type} entries
18+
*
19+
* @param {string} contentType - Content type's name pluralized
20+
* @param {Strapi4RequestParams} [params] - Query parameters
21+
* @returns Promise<T>
22+
*/
23+
const find = <T>(contentType: string, params?: Strapi4RequestParams, fetchOptions?: FetchOptions): Promise<Strapi4ResponseMany<T>> => {
24+
return client(`/${contentType}`, { method: 'GET', params, ...fetchOptions })
25+
}
26+
27+
/**
28+
* Get a specific {content-type} entry
29+
*
30+
* @param {string} contentType - Content type's name pluralized
31+
* @param {string|number} id - ID of entry
32+
* @param {Strapi4RequestParams} [params] - Query parameters
33+
* @returns Promise<T>
34+
*/
35+
const findOne = <T>(contentType: string, id?: string | number | Strapi4RequestParams, params?: Strapi4RequestParams, fetchOptions?: FetchOptions): Promise<Strapi4ResponseSingle<T>> => {
36+
if (typeof id === 'object') {
37+
params = id
38+
id = undefined
39+
}
40+
41+
const path = [contentType, id].filter(Boolean).join('/')
42+
43+
return client(path, { method: 'GET', params, ...fetchOptions })
44+
}
45+
46+
/**
47+
* Create a {content-type} entry
48+
*
49+
* @param {string} contentType - Content type's name pluralized
50+
* @param {Record<string, any>} data - Form data
51+
* @returns Promise<T>
52+
*/
53+
const create = <T>(contentType: string, data: Partial<T>): Promise<Strapi4ResponseSingle<T>> => {
54+
return client(`/${contentType}`, { method: 'POST', body: { data } })
55+
}
56+
57+
/**
58+
* Update an entry
59+
*
60+
* @param {string} contentType - Content type's name pluralized
61+
* @param {string|number} id - ID of entry to be updated
62+
* @param {Record<string, any>} data - Form data
63+
* @returns Promise<T>
64+
*/
65+
const update = <T>(contentType: string, id: string | number | Partial<T>, data?: Partial<T>): Promise<Strapi4ResponseSingle<T>> => {
66+
if (typeof id === 'object') {
67+
data = id
68+
id = undefined
69+
}
70+
71+
const path = [contentType, id].filter(Boolean).join('/')
72+
73+
return client(path, { method: 'PUT', body: { data } })
74+
}
75+
76+
/**
77+
* Delete an entry
78+
*
79+
* @param {string} contentType - Content type's name pluralized
80+
* @param {string|number} id - ID of entry to be deleted
81+
* @returns Promise<T>
82+
*/
83+
const _delete = <T>(contentType: string, id?: string | number): Promise<Strapi4ResponseSingle<T>> => {
84+
const path = [contentType, id].filter(Boolean).join('/')
85+
86+
return client(path, { method: 'DELETE' })
87+
}
88+
89+
return {
90+
find,
91+
findOne,
92+
create,
93+
update,
94+
delete: _delete
95+
}
1496
}

0 commit comments

Comments
 (0)