@keboola/api-client-react 4.0.0 → 6.0.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +2 -2
- package/dist/index.cjs +2 -2
- package/dist/index.cjs.map +1 -1
- package/dist/index.js +2 -2
- package/dist/index.js.map +1 -1
- package/package.json +2 -2
package/README.md
CHANGED
|
@@ -47,8 +47,8 @@ const Tables = () => {
|
|
|
47
47
|
## Exported hooks
|
|
48
48
|
|
|
49
49
|
- `useApiClient()` — returns the initialised `ApiClient`.
|
|
50
|
-
- `useProject()` — returns `client.project` (project features + backend availability).
|
|
51
|
-
- `useStack()` — returns `client.stack` (service discovery + feature flags).
|
|
50
|
+
- `useProject()` — returns `client.context.project` (project features + backend availability).
|
|
51
|
+
- `useStack()` — returns `client.context.stack` (service discovery + feature flags).
|
|
52
52
|
- `useDevApiClient()` — companion hook for `DevApiClientProvider`, used by tooling that needs the dev/raw client.
|
|
53
53
|
|
|
54
54
|
## Ownership
|
package/dist/index.cjs
CHANGED
|
@@ -17,12 +17,12 @@ var useApiClient = () => {
|
|
|
17
17
|
var useProject = () => {
|
|
18
18
|
const client = react.use(Context);
|
|
19
19
|
if (client === null) throw new Error(MISSING_PROJECT_ERROR);
|
|
20
|
-
return client.project;
|
|
20
|
+
return client.context.project;
|
|
21
21
|
};
|
|
22
22
|
var useStack = () => {
|
|
23
23
|
const client = react.use(Context);
|
|
24
24
|
if (client === null) throw new Error(MISSING_STACK_ERROR);
|
|
25
|
-
return client.stack;
|
|
25
|
+
return client.context.stack;
|
|
26
26
|
};
|
|
27
27
|
var ApiClientProvider = ({ client, children, fallback = null, ...rest }) => {
|
|
28
28
|
const [isInitializing, setIsInitializing] = react.useState(true);
|
package/dist/index.cjs.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"sources":["../src/context.ts","../src/ApiClientProvider.tsx","../src/devContext.ts","../src/DevApiClientProvider.tsx"],"names":["createContext","use","useState","useEffect","jsx","Context","Provider"],"mappings":";;;;;;AAIA,IAAM,wBAAA,GAA2B,wDAAA;AACjC,IAAM,qBAAA,GAAwB,sDAAA;AAC9B,IAAM,mBAAA,GAAsB,oDAAA;AAE5B,IAAM,OAAA,GAAUA,oBAAgC,IAAI,CAAA;AAE7C,IAAM,QAAA,GAAW,OAAA;AAEjB,IAAM,eAAe,MAAM;AAChC,EAAA,MAAM,MAAA,GAASC,UAAI,OAAO,CAAA;AAC1B,EAAA,IAAI,MAAA,KAAW,IAAA,EAAM,MAAM,IAAI,MAAM,wBAAwB,CAAA;AAC7D,EAAA,OAAO,MAAA;AACT;AAEO,IAAM,aAAa,MAAM;AAC9B,EAAA,MAAM,MAAA,GAASA,UAAI,OAAO,CAAA;AAC1B,EAAA,IAAI,MAAA,KAAW,IAAA,EAAM,MAAM,IAAI,MAAM,qBAAqB,CAAA;AAC1D,EAAA,OAAO,
|
|
1
|
+
{"version":3,"sources":["../src/context.ts","../src/ApiClientProvider.tsx","../src/devContext.ts","../src/DevApiClientProvider.tsx"],"names":["createContext","use","useState","useEffect","jsx","Context","Provider"],"mappings":";;;;;;AAIA,IAAM,wBAAA,GAA2B,wDAAA;AACjC,IAAM,qBAAA,GAAwB,sDAAA;AAC9B,IAAM,mBAAA,GAAsB,oDAAA;AAE5B,IAAM,OAAA,GAAUA,oBAAgC,IAAI,CAAA;AAE7C,IAAM,QAAA,GAAW,OAAA;AAEjB,IAAM,eAAe,MAAM;AAChC,EAAA,MAAM,MAAA,GAASC,UAAI,OAAO,CAAA;AAC1B,EAAA,IAAI,MAAA,KAAW,IAAA,EAAM,MAAM,IAAI,MAAM,wBAAwB,CAAA;AAC7D,EAAA,OAAO,MAAA;AACT;AAEO,IAAM,aAAa,MAAM;AAC9B,EAAA,MAAM,MAAA,GAASA,UAAI,OAAO,CAAA;AAC1B,EAAA,IAAI,MAAA,KAAW,IAAA,EAAM,MAAM,IAAI,MAAM,qBAAqB,CAAA;AAC1D,EAAA,OAAO,OAAO,OAAA,CAAQ,OAAA;AACxB;AAEO,IAAM,WAAW,MAAM;AAC5B,EAAA,MAAM,MAAA,GAASA,UAAI,OAAO,CAAA;AAC1B,EAAA,IAAI,MAAA,KAAW,IAAA,EAAM,MAAM,IAAI,MAAM,mBAAmB,CAAA;AACxD,EAAA,OAAO,OAAO,OAAA,CAAQ,KAAA;AACxB;ACfO,IAAM,iBAAA,GAAoB,CAAC,EAAE,MAAA,EAAQ,UAAU,QAAA,GAAW,IAAA,EAAM,GAAG,IAAA,EAAK,KAAa;AAC1F,EAAA,MAAM,CAAC,cAAA,EAAgB,iBAAiB,CAAA,GAAIC,eAAkB,IAAI,CAAA;AAElE,EAAAC,eAAA,CAAU,MAAM;AACd,IAAA,MAAA,CAAO,IAAA,CAAK,IAAI,CAAA,CAAE,OAAA,CAAQ,MAAM;AAC9B,MAAA,iBAAA,CAAkB,KAAK,CAAA;AAAA,IACzB,CAAC,CAAA;AAAA,EAGH,CAAA,EAAG,EAAE,CAAA;AAEL,EAAA,OAAO,iBAAiB,QAAA,mBAAWC,cAAA,CAAC,QAAA,EAAA,EAAS,KAAA,EAAO,QAAS,QAAA,EAAS,CAAA;AACxE;ACrBA,IAAM,0BAAA,GAA6B,8DAAA;AAEnC,IAAMC,QAAAA,GAAUL,oBAA4D,IAAI,CAAA;AAEzE,IAAMM,SAAAA,GAAWD,QAAAA;AAEjB,IAAM,kBAAkB,MAAM;AACnC,EAAA,MAAM,YAAA,GAAeJ,UAAII,QAAO,CAAA;AAChC,EAAA,IAAI,YAAA,KAAiB,IAAA,EAAM,MAAM,IAAI,MAAM,0BAA0B,CAAA;AACrE,EAAA,OAAO,YAAA;AACT;ACDO,IAAM,oBAAA,GAAuB,CAAC,EAAE,MAAA,EAAQ,QAAA,EAAS,qBACtDD,cAAAA,CAACE,SAAAA,EAAA,EAAS,KAAA,EAAO,MAAA,EAAS,QAAA,EAAS","file":"index.cjs","sourcesContent":["import { createContext, use } from 'react';\n\nimport type { ApiClient } from '@keboola/api-client';\n\nconst MISSING_API_CLIENT_ERROR = 'useApiClient must be used within <ApiClientProvider />';\nconst MISSING_PROJECT_ERROR = 'useProject must be used within <ApiClientProvider />';\nconst MISSING_STACK_ERROR = 'useStack must be used within <ApiClientProvider />';\n\nconst Context = createContext<ApiClient | null>(null);\n\nexport const Provider = Context;\n\nexport const useApiClient = () => {\n const client = use(Context);\n if (client === null) throw new Error(MISSING_API_CLIENT_ERROR);\n return client;\n};\n\nexport const useProject = () => {\n const client = use(Context);\n if (client === null) throw new Error(MISSING_PROJECT_ERROR);\n return client.context.project;\n};\n\nexport const useStack = () => {\n const client = use(Context);\n if (client === null) throw new Error(MISSING_STACK_ERROR);\n return client.context.stack;\n};\n","import { useEffect, useState } from 'react';\nimport type { ReactNode } from 'react';\n\nimport type { ApiClient, ApiClientOptions } from '@keboola/api-client';\n\nimport { Provider } from './context';\n\ntype Props = {\n client: ApiClient;\n children: ReactNode;\n fallback?: ReactNode;\n} & ApiClientOptions;\n\nexport const ApiClientProvider = ({ client, children, fallback = null, ...rest }: Props) => {\n const [isInitializing, setIsInitializing] = useState<boolean>(true);\n\n useEffect(() => {\n client.init(rest).finally(() => {\n setIsInitializing(false);\n });\n // we want to init only on initial mount\n // oxlint-disable-next-line react/exhaustive-deps\n }, []);\n\n return isInitializing ? fallback : <Provider value={client}>{children}</Provider>;\n};\n","import { createContext, use } from 'react';\n\nimport type { createDevApiClient } from '@keboola/api-client';\n\nconst MISSING_DEV_PROVIDER_ERROR = 'useDevApiClient must be used within <DevApiClientProvider />';\n\nconst Context = createContext<ReturnType<typeof createDevApiClient> | null>(null);\n\nexport const Provider = Context;\n\nexport const useDevApiClient = () => {\n const devApiClient = use(Context);\n if (devApiClient === null) throw new Error(MISSING_DEV_PROVIDER_ERROR);\n return devApiClient;\n};\n","import type { ReactNode } from 'react';\n\nimport type { createDevApiClient } from '@keboola/api-client';\n\nimport { Provider } from './devContext';\n\ntype DevClient = ReturnType<typeof createDevApiClient>;\n\ntype Props = {\n client: DevClient;\n children: ReactNode;\n};\n\nexport const DevApiClientProvider = ({ client, children }: Props) => (\n <Provider value={client}>{children}</Provider>\n);\n"]}
|
package/dist/index.js
CHANGED
|
@@ -15,12 +15,12 @@ var useApiClient = () => {
|
|
|
15
15
|
var useProject = () => {
|
|
16
16
|
const client = use(Context);
|
|
17
17
|
if (client === null) throw new Error(MISSING_PROJECT_ERROR);
|
|
18
|
-
return client.project;
|
|
18
|
+
return client.context.project;
|
|
19
19
|
};
|
|
20
20
|
var useStack = () => {
|
|
21
21
|
const client = use(Context);
|
|
22
22
|
if (client === null) throw new Error(MISSING_STACK_ERROR);
|
|
23
|
-
return client.stack;
|
|
23
|
+
return client.context.stack;
|
|
24
24
|
};
|
|
25
25
|
var ApiClientProvider = ({ client, children, fallback = null, ...rest }) => {
|
|
26
26
|
const [isInitializing, setIsInitializing] = useState(true);
|
package/dist/index.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"sources":["../src/context.ts","../src/ApiClientProvider.tsx","../src/devContext.ts","../src/DevApiClientProvider.tsx"],"names":["Context","createContext","Provider","use","jsx"],"mappings":";;;;AAIA,IAAM,wBAAA,GAA2B,wDAAA;AACjC,IAAM,qBAAA,GAAwB,sDAAA;AAC9B,IAAM,mBAAA,GAAsB,oDAAA;AAE5B,IAAM,OAAA,GAAU,cAAgC,IAAI,CAAA;AAE7C,IAAM,QAAA,GAAW,OAAA;AAEjB,IAAM,eAAe,MAAM;AAChC,EAAA,MAAM,MAAA,GAAS,IAAI,OAAO,CAAA;AAC1B,EAAA,IAAI,MAAA,KAAW,IAAA,EAAM,MAAM,IAAI,MAAM,wBAAwB,CAAA;AAC7D,EAAA,OAAO,MAAA;AACT;AAEO,IAAM,aAAa,MAAM;AAC9B,EAAA,MAAM,MAAA,GAAS,IAAI,OAAO,CAAA;AAC1B,EAAA,IAAI,MAAA,KAAW,IAAA,EAAM,MAAM,IAAI,MAAM,qBAAqB,CAAA;AAC1D,EAAA,OAAO,
|
|
1
|
+
{"version":3,"sources":["../src/context.ts","../src/ApiClientProvider.tsx","../src/devContext.ts","../src/DevApiClientProvider.tsx"],"names":["Context","createContext","Provider","use","jsx"],"mappings":";;;;AAIA,IAAM,wBAAA,GAA2B,wDAAA;AACjC,IAAM,qBAAA,GAAwB,sDAAA;AAC9B,IAAM,mBAAA,GAAsB,oDAAA;AAE5B,IAAM,OAAA,GAAU,cAAgC,IAAI,CAAA;AAE7C,IAAM,QAAA,GAAW,OAAA;AAEjB,IAAM,eAAe,MAAM;AAChC,EAAA,MAAM,MAAA,GAAS,IAAI,OAAO,CAAA;AAC1B,EAAA,IAAI,MAAA,KAAW,IAAA,EAAM,MAAM,IAAI,MAAM,wBAAwB,CAAA;AAC7D,EAAA,OAAO,MAAA;AACT;AAEO,IAAM,aAAa,MAAM;AAC9B,EAAA,MAAM,MAAA,GAAS,IAAI,OAAO,CAAA;AAC1B,EAAA,IAAI,MAAA,KAAW,IAAA,EAAM,MAAM,IAAI,MAAM,qBAAqB,CAAA;AAC1D,EAAA,OAAO,OAAO,OAAA,CAAQ,OAAA;AACxB;AAEO,IAAM,WAAW,MAAM;AAC5B,EAAA,MAAM,MAAA,GAAS,IAAI,OAAO,CAAA;AAC1B,EAAA,IAAI,MAAA,KAAW,IAAA,EAAM,MAAM,IAAI,MAAM,mBAAmB,CAAA;AACxD,EAAA,OAAO,OAAO,OAAA,CAAQ,KAAA;AACxB;ACfO,IAAM,iBAAA,GAAoB,CAAC,EAAE,MAAA,EAAQ,UAAU,QAAA,GAAW,IAAA,EAAM,GAAG,IAAA,EAAK,KAAa;AAC1F,EAAA,MAAM,CAAC,cAAA,EAAgB,iBAAiB,CAAA,GAAI,SAAkB,IAAI,CAAA;AAElE,EAAA,SAAA,CAAU,MAAM;AACd,IAAA,MAAA,CAAO,IAAA,CAAK,IAAI,CAAA,CAAE,OAAA,CAAQ,MAAM;AAC9B,MAAA,iBAAA,CAAkB,KAAK,CAAA;AAAA,IACzB,CAAC,CAAA;AAAA,EAGH,CAAA,EAAG,EAAE,CAAA;AAEL,EAAA,OAAO,iBAAiB,QAAA,mBAAW,GAAA,CAAC,QAAA,EAAA,EAAS,KAAA,EAAO,QAAS,QAAA,EAAS,CAAA;AACxE;ACrBA,IAAM,0BAAA,GAA6B,8DAAA;AAEnC,IAAMA,QAAAA,GAAUC,cAA4D,IAAI,CAAA;AAEzE,IAAMC,SAAAA,GAAWF,QAAAA;AAEjB,IAAM,kBAAkB,MAAM;AACnC,EAAA,MAAM,YAAA,GAAeG,IAAIH,QAAO,CAAA;AAChC,EAAA,IAAI,YAAA,KAAiB,IAAA,EAAM,MAAM,IAAI,MAAM,0BAA0B,CAAA;AACrE,EAAA,OAAO,YAAA;AACT;ACDO,IAAM,oBAAA,GAAuB,CAAC,EAAE,MAAA,EAAQ,QAAA,EAAS,qBACtDI,GAAAA,CAACF,SAAAA,EAAA,EAAS,KAAA,EAAO,MAAA,EAAS,QAAA,EAAS","file":"index.js","sourcesContent":["import { createContext, use } from 'react';\n\nimport type { ApiClient } from '@keboola/api-client';\n\nconst MISSING_API_CLIENT_ERROR = 'useApiClient must be used within <ApiClientProvider />';\nconst MISSING_PROJECT_ERROR = 'useProject must be used within <ApiClientProvider />';\nconst MISSING_STACK_ERROR = 'useStack must be used within <ApiClientProvider />';\n\nconst Context = createContext<ApiClient | null>(null);\n\nexport const Provider = Context;\n\nexport const useApiClient = () => {\n const client = use(Context);\n if (client === null) throw new Error(MISSING_API_CLIENT_ERROR);\n return client;\n};\n\nexport const useProject = () => {\n const client = use(Context);\n if (client === null) throw new Error(MISSING_PROJECT_ERROR);\n return client.context.project;\n};\n\nexport const useStack = () => {\n const client = use(Context);\n if (client === null) throw new Error(MISSING_STACK_ERROR);\n return client.context.stack;\n};\n","import { useEffect, useState } from 'react';\nimport type { ReactNode } from 'react';\n\nimport type { ApiClient, ApiClientOptions } from '@keboola/api-client';\n\nimport { Provider } from './context';\n\ntype Props = {\n client: ApiClient;\n children: ReactNode;\n fallback?: ReactNode;\n} & ApiClientOptions;\n\nexport const ApiClientProvider = ({ client, children, fallback = null, ...rest }: Props) => {\n const [isInitializing, setIsInitializing] = useState<boolean>(true);\n\n useEffect(() => {\n client.init(rest).finally(() => {\n setIsInitializing(false);\n });\n // we want to init only on initial mount\n // oxlint-disable-next-line react/exhaustive-deps\n }, []);\n\n return isInitializing ? fallback : <Provider value={client}>{children}</Provider>;\n};\n","import { createContext, use } from 'react';\n\nimport type { createDevApiClient } from '@keboola/api-client';\n\nconst MISSING_DEV_PROVIDER_ERROR = 'useDevApiClient must be used within <DevApiClientProvider />';\n\nconst Context = createContext<ReturnType<typeof createDevApiClient> | null>(null);\n\nexport const Provider = Context;\n\nexport const useDevApiClient = () => {\n const devApiClient = use(Context);\n if (devApiClient === null) throw new Error(MISSING_DEV_PROVIDER_ERROR);\n return devApiClient;\n};\n","import type { ReactNode } from 'react';\n\nimport type { createDevApiClient } from '@keboola/api-client';\n\nimport { Provider } from './devContext';\n\ntype DevClient = ReturnType<typeof createDevApiClient>;\n\ntype Props = {\n client: DevClient;\n children: ReactNode;\n};\n\nexport const DevApiClientProvider = ({ client, children }: Props) => (\n <Provider value={client}>{children}</Provider>\n);\n"]}
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@keboola/api-client-react",
|
|
3
|
-
"version": "
|
|
3
|
+
"version": "6.0.0",
|
|
4
4
|
"description": "React bindings for @keboola/api-client",
|
|
5
5
|
"license": "MIT",
|
|
6
6
|
"type": "module",
|
|
@@ -62,7 +62,7 @@
|
|
|
62
62
|
}
|
|
63
63
|
},
|
|
64
64
|
"peerDependencies": {
|
|
65
|
-
"@keboola/api-client": "^
|
|
65
|
+
"@keboola/api-client": "^6.0.0",
|
|
66
66
|
"react": "^19.0.0"
|
|
67
67
|
},
|
|
68
68
|
"devDependencies": {
|