@djangocfg/ext-base 1.0.0 → 1.0.1

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/dist/api.cjs DELETED
@@ -1,41 +0,0 @@
1
- 'use strict';
2
-
3
- var __require = /* @__PURE__ */ ((x) => typeof require !== "undefined" ? require : typeof Proxy !== "undefined" ? new Proxy(x, {
4
- get: (a, b) => (typeof require !== "undefined" ? require : a)[b]
5
- }) : x)(function(x) {
6
- if (typeof require !== "undefined") return require.apply(this, arguments);
7
- throw Error('Dynamic require of "' + x + '" is not supported');
8
- });
9
-
10
- // src/config/env.ts
11
- process.env.NODE_ENV === "development";
12
- process.env.NODE_ENV === "production";
13
- process.env.NODE_ENV === "test";
14
- var isStaticBuild = process.env.NEXT_PUBLIC_STATIC_BUILD === "true";
15
- var getApiUrl = () => {
16
- return process.env.NEXT_PUBLIC_API_URL || "";
17
- };
18
-
19
- // src/api/createExtensionAPI.ts
20
- function createExtensionAPI(APIClass) {
21
- let storage;
22
- try {
23
- const { api: accountsApi } = __require("@djangocfg/api");
24
- storage = accountsApi._storage;
25
- } catch (error) {
26
- storage = void 0;
27
- }
28
- const apiUrl = isStaticBuild ? "" : getApiUrl();
29
- return new APIClass(apiUrl, storage ? { storage } : void 0);
30
- }
31
- function getSharedAuthStorage() {
32
- try {
33
- const { api: accountsApi } = __require("@djangocfg/api");
34
- return accountsApi._storage;
35
- } catch (error) {
36
- return void 0;
37
- }
38
- }
39
-
40
- exports.createExtensionAPI = createExtensionAPI;
41
- exports.getSharedAuthStorage = getSharedAuthStorage;
package/dist/api.d.cts DELETED
@@ -1,35 +0,0 @@
1
- /**
2
- * Factory for creating extension API instances
3
- *
4
- * Provides consistent API setup across all extensions with shared authentication
5
- */
6
- /**
7
- * Creates an extension API instance with shared authentication storage
8
- *
9
- * @param APIClass - The generated API class from your extension
10
- * @returns Configured API instance with shared auth storage
11
- *
12
- * @example
13
- * ```typescript
14
- * // In your extension's api/index.ts
15
- * import { API } from './generated/ext_newsletter';
16
- * import { createExtensionAPI } from '@djangocfg/ext-base/api';
17
- *
18
- * export const apiNewsletter = createExtensionAPI(API);
19
- * ```
20
- */
21
- declare function createExtensionAPI<T>(APIClass: new (url: string, options?: any) => T): T;
22
- /**
23
- * Get shared authentication storage from accounts API
24
- *
25
- * @returns Storage instance or undefined if not available
26
- *
27
- * @example
28
- * ```typescript
29
- * const storage = getSharedAuthStorage();
30
- * const api = new API(apiUrl, { storage });
31
- * ```
32
- */
33
- declare function getSharedAuthStorage(): any | undefined;
34
-
35
- export { createExtensionAPI, getSharedAuthStorage };
package/dist/api.d.ts DELETED
@@ -1,35 +0,0 @@
1
- /**
2
- * Factory for creating extension API instances
3
- *
4
- * Provides consistent API setup across all extensions with shared authentication
5
- */
6
- /**
7
- * Creates an extension API instance with shared authentication storage
8
- *
9
- * @param APIClass - The generated API class from your extension
10
- * @returns Configured API instance with shared auth storage
11
- *
12
- * @example
13
- * ```typescript
14
- * // In your extension's api/index.ts
15
- * import { API } from './generated/ext_newsletter';
16
- * import { createExtensionAPI } from '@djangocfg/ext-base/api';
17
- *
18
- * export const apiNewsletter = createExtensionAPI(API);
19
- * ```
20
- */
21
- declare function createExtensionAPI<T>(APIClass: new (url: string, options?: any) => T): T;
22
- /**
23
- * Get shared authentication storage from accounts API
24
- *
25
- * @returns Storage instance or undefined if not available
26
- *
27
- * @example
28
- * ```typescript
29
- * const storage = getSharedAuthStorage();
30
- * const api = new API(apiUrl, { storage });
31
- * ```
32
- */
33
- declare function getSharedAuthStorage(): any | undefined;
34
-
35
- export { createExtensionAPI, getSharedAuthStorage };
package/dist/api.js DELETED
@@ -1,2 +0,0 @@
1
- export { createExtensionAPI, getSharedAuthStorage } from './chunk-MECBWZG4.js';
2
- import './chunk-3RG5ZIWI.js';
package/dist/auth.cjs DELETED
@@ -1,10 +0,0 @@
1
- 'use strict';
2
-
3
- var auth = require('@djangocfg/api/auth');
4
-
5
-
6
-
7
- Object.defineProperty(exports, "useAuth", {
8
- enumerable: true,
9
- get: function () { return auth.useAuth; }
10
- });
package/dist/auth.d.cts DELETED
@@ -1 +0,0 @@
1
- export { AuthContextType, UserProfile, useAuth } from '@djangocfg/api/auth';
package/dist/auth.d.ts DELETED
@@ -1 +0,0 @@
1
- export { AuthContextType, UserProfile, useAuth } from '@djangocfg/api/auth';
package/dist/auth.js DELETED
@@ -1,2 +0,0 @@
1
- import './chunk-3RG5ZIWI.js';
2
- export { useAuth } from '@djangocfg/api/auth';
@@ -1,8 +0,0 @@
1
- var __require = /* @__PURE__ */ ((x) => typeof require !== "undefined" ? require : typeof Proxy !== "undefined" ? new Proxy(x, {
2
- get: (a, b) => (typeof require !== "undefined" ? require : a)[b]
3
- }) : x)(function(x) {
4
- if (typeof require !== "undefined") return require.apply(this, arguments);
5
- throw Error('Dynamic require of "' + x + '" is not supported');
6
- });
7
-
8
- export { __require };
@@ -1,44 +0,0 @@
1
- import { __require } from './chunk-3RG5ZIWI.js';
2
-
3
- // src/config/env.ts
4
- var isDevelopment = process.env.NODE_ENV === "development";
5
- var isProduction = process.env.NODE_ENV === "production";
6
- var isTest = process.env.NODE_ENV === "test";
7
- var isStaticBuild = process.env.NEXT_PUBLIC_STATIC_BUILD === "true";
8
- var isClient = typeof window !== "undefined";
9
- var isServer = !isClient;
10
- var getApiUrl = () => {
11
- return process.env.NEXT_PUBLIC_API_URL || "";
12
- };
13
- var env = {
14
- isDevelopment,
15
- isProduction,
16
- isTest,
17
- isStaticBuild,
18
- isClient,
19
- isServer,
20
- getApiUrl
21
- };
22
-
23
- // src/api/createExtensionAPI.ts
24
- function createExtensionAPI(APIClass) {
25
- let storage;
26
- try {
27
- const { api: accountsApi } = __require("@djangocfg/api");
28
- storage = accountsApi._storage;
29
- } catch (error) {
30
- storage = void 0;
31
- }
32
- const apiUrl = isStaticBuild ? "" : getApiUrl();
33
- return new APIClass(apiUrl, storage ? { storage } : void 0);
34
- }
35
- function getSharedAuthStorage() {
36
- try {
37
- const { api: accountsApi } = __require("@djangocfg/api");
38
- return accountsApi._storage;
39
- } catch (error) {
40
- return void 0;
41
- }
42
- }
43
-
44
- export { createExtensionAPI, env, getApiUrl, getSharedAuthStorage, isClient, isDevelopment, isProduction, isServer, isStaticBuild, isTest };
@@ -1,67 +0,0 @@
1
- import { createConsola } from 'consola';
2
-
3
- // src/utils/errors.ts
4
- function isExtensionError(error) {
5
- return typeof error === "object" && error !== null && "message" in error && "timestamp" in error;
6
- }
7
- function createExtensionError(error, code, details) {
8
- const message = error instanceof Error ? error.message : String(error);
9
- return {
10
- message,
11
- code,
12
- details,
13
- timestamp: (/* @__PURE__ */ new Date()).toISOString()
14
- };
15
- }
16
- function formatErrorMessage(error) {
17
- if (isExtensionError(error)) {
18
- return error.code ? `[${error.code}] ${error.message}` : error.message;
19
- }
20
- if (error instanceof Error) {
21
- return error.message;
22
- }
23
- return String(error);
24
- }
25
- function handleExtensionError(error, logger, callback) {
26
- const extensionError = isExtensionError(error) ? error : createExtensionError(error);
27
- if (logger) {
28
- logger.error("Extension error:", extensionError);
29
- }
30
- if (callback) {
31
- callback(extensionError);
32
- }
33
- }
34
- var isDevelopment = process.env.NODE_ENV === "development";
35
- var LEVEL_MAP = {
36
- debug: 4,
37
- info: 3,
38
- warn: 2,
39
- error: 1
40
- };
41
- function createExtensionLogger(options) {
42
- const { tag, level = "info", enabled = true } = options;
43
- if (!enabled) {
44
- const noop = () => {
45
- };
46
- return {
47
- info: noop,
48
- warn: noop,
49
- error: noop,
50
- debug: noop,
51
- success: noop
52
- };
53
- }
54
- const logLevel = isDevelopment ? LEVEL_MAP[level] : LEVEL_MAP.error;
55
- const consola = createConsola({
56
- level: logLevel
57
- }).withTag(tag);
58
- return {
59
- info: (...args) => consola.info(...args),
60
- warn: (...args) => consola.warn(...args),
61
- error: (...args) => consola.error(...args),
62
- debug: (...args) => consola.debug(...args),
63
- success: (...args) => consola.success(...args)
64
- };
65
- }
66
-
67
- export { createExtensionError, createExtensionLogger, formatErrorMessage, handleExtensionError, isExtensionError };
package/dist/hooks.cjs DELETED
@@ -1,190 +0,0 @@
1
- 'use strict';
2
-
3
- var consola = require('consola');
4
- var react = require('react');
5
- var jsxRuntime = require('react/jsx-runtime');
6
- var swr = require('swr');
7
-
8
- var __require = /* @__PURE__ */ ((x) => typeof require !== "undefined" ? require : typeof Proxy !== "undefined" ? new Proxy(x, {
9
- get: (a, b) => (typeof require !== "undefined" ? require : a)[b]
10
- }) : x)(function(x) {
11
- if (typeof require !== "undefined") return require.apply(this, arguments);
12
- throw Error('Dynamic require of "' + x + '" is not supported');
13
- });
14
-
15
- // src/config/env.ts
16
- var isDevelopment = process.env.NODE_ENV === "development";
17
- var isProduction = process.env.NODE_ENV === "production";
18
- var isTest = process.env.NODE_ENV === "test";
19
- var isStaticBuild = process.env.NEXT_PUBLIC_STATIC_BUILD === "true";
20
- var isClient = typeof window !== "undefined";
21
- var isServer = !isClient;
22
- var getApiUrl = () => {
23
- return process.env.NEXT_PUBLIC_API_URL || "";
24
- };
25
- var env = {
26
- isDevelopment,
27
- isProduction,
28
- isTest,
29
- isStaticBuild,
30
- isClient,
31
- isServer,
32
- getApiUrl
33
- };
34
-
35
- // src/api/createExtensionAPI.ts
36
- function createExtensionAPI(APIClass) {
37
- let storage;
38
- try {
39
- const { api: accountsApi } = __require("@djangocfg/api");
40
- storage = accountsApi._storage;
41
- } catch (error) {
42
- storage = void 0;
43
- }
44
- const apiUrl = isStaticBuild ? "" : getApiUrl();
45
- return new APIClass(apiUrl, storage ? { storage } : void 0);
46
- }
47
- function getSharedAuthStorage() {
48
- try {
49
- const { api: accountsApi } = __require("@djangocfg/api");
50
- return accountsApi._storage;
51
- } catch (error) {
52
- return void 0;
53
- }
54
- }
55
-
56
- // src/utils/errors.ts
57
- function isExtensionError(error) {
58
- return typeof error === "object" && error !== null && "message" in error && "timestamp" in error;
59
- }
60
- function createExtensionError(error, code, details) {
61
- const message = error instanceof Error ? error.message : String(error);
62
- return {
63
- message,
64
- code,
65
- details,
66
- timestamp: (/* @__PURE__ */ new Date()).toISOString()
67
- };
68
- }
69
- function formatErrorMessage(error) {
70
- if (isExtensionError(error)) {
71
- return error.code ? `[${error.code}] ${error.message}` : error.message;
72
- }
73
- if (error instanceof Error) {
74
- return error.message;
75
- }
76
- return String(error);
77
- }
78
- function handleExtensionError(error, logger, callback) {
79
- const extensionError = isExtensionError(error) ? error : createExtensionError(error);
80
- if (logger) {
81
- logger.error("Extension error:", extensionError);
82
- }
83
- if (callback) {
84
- callback(extensionError);
85
- }
86
- }
87
- var isDevelopment2 = process.env.NODE_ENV === "development";
88
- var LEVEL_MAP = {
89
- debug: 4,
90
- info: 3,
91
- warn: 2,
92
- error: 1
93
- };
94
- function createExtensionLogger(options) {
95
- const { tag, level = "info", enabled = true } = options;
96
- if (!enabled) {
97
- const noop = () => {
98
- };
99
- return {
100
- info: noop,
101
- warn: noop,
102
- error: noop,
103
- debug: noop,
104
- success: noop
105
- };
106
- }
107
- const logLevel = isDevelopment2 ? LEVEL_MAP[level] : LEVEL_MAP.error;
108
- const consola$1 = consola.createConsola({
109
- level: logLevel
110
- }).withTag(tag);
111
- return {
112
- info: (...args) => consola$1.info(...args),
113
- warn: (...args) => consola$1.warn(...args),
114
- error: (...args) => consola$1.error(...args),
115
- debug: (...args) => consola$1.debug(...args),
116
- success: (...args) => consola$1.success(...args)
117
- };
118
- }
119
- function createExtensionContext({
120
- displayName,
121
- errorMessage
122
- }) {
123
- const Context = react.createContext(void 0);
124
- Context.displayName = displayName;
125
- const Provider = ({ value, children }) => {
126
- return /* @__PURE__ */ jsxRuntime.jsx(Context.Provider, { value, children });
127
- };
128
- const useContextHook = () => {
129
- const context = react.useContext(Context);
130
- if (context === void 0) {
131
- throw new Error(
132
- errorMessage || `use${displayName} must be used within ${displayName}Provider`
133
- );
134
- }
135
- return context;
136
- };
137
- return {
138
- Context,
139
- Provider,
140
- useContext: useContextHook
141
- };
142
- }
143
- var DEFAULT_OPTIONS = {
144
- revalidateOnFocus: false,
145
- revalidateOnReconnect: false,
146
- revalidateIfStale: false
147
- };
148
- var registeredExtensions = /* @__PURE__ */ new Set();
149
- function ExtensionProvider({ children, metadata, options = {} }) {
150
- const config = { ...DEFAULT_OPTIONS, ...options };
151
- react.useEffect(() => {
152
- if (registeredExtensions.has(metadata.name)) {
153
- if (isDevelopment) {
154
- console.warn(
155
- `[ExtensionProvider] Extension "${metadata.name}" is already registered. This might indicate that the extension is mounted multiple times.`
156
- );
157
- }
158
- return;
159
- }
160
- registeredExtensions.add(metadata.name);
161
- if (isDevelopment) {
162
- const logger = createExtensionLogger({ tag: "ext-base", level: "info" });
163
- logger.info(
164
- `Extension registered: ${metadata.displayName || metadata.name} v${metadata.version}`
165
- );
166
- }
167
- return () => {
168
- registeredExtensions.delete(metadata.name);
169
- };
170
- }, [metadata.name, metadata.version, metadata.displayName]);
171
- return /* @__PURE__ */ jsxRuntime.jsx(swr.SWRConfig, { value: config, children });
172
- }
173
-
174
- exports.ExtensionProvider = ExtensionProvider;
175
- exports.createExtensionAPI = createExtensionAPI;
176
- exports.createExtensionContext = createExtensionContext;
177
- exports.createExtensionError = createExtensionError;
178
- exports.createExtensionLogger = createExtensionLogger;
179
- exports.env = env;
180
- exports.formatErrorMessage = formatErrorMessage;
181
- exports.getApiUrl = getApiUrl;
182
- exports.getSharedAuthStorage = getSharedAuthStorage;
183
- exports.handleExtensionError = handleExtensionError;
184
- exports.isClient = isClient;
185
- exports.isDevelopment = isDevelopment;
186
- exports.isExtensionError = isExtensionError;
187
- exports.isProduction = isProduction;
188
- exports.isServer = isServer;
189
- exports.isStaticBuild = isStaticBuild;
190
- exports.isTest = isTest;
package/dist/hooks.d.cts DELETED
@@ -1,96 +0,0 @@
1
- import { ExtensionProviderProps } from './index.cjs';
2
- export { ErrorHandler, ExtensionContextOptions, ExtensionError, ExtensionLogger, ExtensionMetadata, InfinitePaginationOptions, InfinitePaginationReturn, LoggerOptions, PaginatedResponse, PaginationParams, PaginationState, createExtensionError, createExtensionLogger, env, formatErrorMessage, getApiUrl, handleExtensionError, isClient, isDevelopment, isExtensionError, isProduction, isServer, isStaticBuild, isTest } from './index.cjs';
3
- export { createExtensionAPI, getSharedAuthStorage } from './api.cjs';
4
- import { Context, ReactNode, ReactElement } from 'react';
5
- import * as react_jsx_runtime from 'react/jsx-runtime';
6
-
7
- /**
8
- * Utility for creating typed React contexts for extensions
9
- */
10
-
11
- interface CreateExtensionContextOptions<T> {
12
- /** Display name for the context (for debugging) */
13
- displayName: string;
14
- /** Error message when hook is used outside provider */
15
- errorMessage?: string;
16
- }
17
- interface ExtensionContextReturn<T> {
18
- /** The React Context */
19
- Context: Context<T | undefined>;
20
- /** Provider component */
21
- Provider: (props: {
22
- value: T;
23
- children: ReactNode;
24
- }) => ReactElement;
25
- /** Hook to access context value */
26
- useContext: () => T;
27
- }
28
- /**
29
- * Creates a typed React context with provider and hook
30
- *
31
- * @example
32
- * ```tsx
33
- * interface MyContextValue {
34
- * data: string[];
35
- * isLoading: boolean;
36
- * }
37
- *
38
- * const { Provider, useContext } = createExtensionContext<MyContextValue>({
39
- * displayName: 'MyContext'
40
- * });
41
- *
42
- * // In provider component:
43
- * <Provider value={{ data: [], isLoading: false }}>
44
- * {children}
45
- * </Provider>
46
- *
47
- * // In consumer component:
48
- * const { data, isLoading } = useContext();
49
- * ```
50
- */
51
- declare function createExtensionContext<T>({ displayName, errorMessage, }: CreateExtensionContextOptions<T>): ExtensionContextReturn<T>;
52
-
53
- /**
54
- * Base provider with SWR configuration for extension contexts
55
- *
56
- * Provides:
57
- * - SWR configuration for data fetching
58
- * - Extension registration and metadata management
59
- * - Auth context from @djangocfg/api (automatically available via useAuth)
60
- *
61
- * @example
62
- * ```tsx
63
- * // In extension package:
64
- * export function NewsletterProvider({ children }: { children: ReactNode }) {
65
- * return (
66
- * <ExtensionProvider
67
- * metadata={{
68
- * name: 'newsletter',
69
- * version: '1.0.0',
70
- * author: 'DjangoCFG',
71
- * displayName: 'Newsletter',
72
- * description: 'Newsletter subscription management',
73
- * icon: '📧',
74
- * license: 'MIT',
75
- * githubUrl: 'https://github.com/markolofsen/django-cfg',
76
- * keywords: ['newsletter', 'email', 'subscription'],
77
- * }}
78
- * options={{ revalidateOnFocus: true }}
79
- * >
80
- * {children}
81
- * </ExtensionProvider>
82
- * );
83
- * }
84
- *
85
- * // In components:
86
- * import { useAuth } from '@djangocfg/api/auth';
87
- *
88
- * function MyComponent() {
89
- * const { user, isAuthenticated } = useAuth();
90
- * // Auth is automatically available!
91
- * }
92
- * ```
93
- */
94
- declare function ExtensionProvider({ children, metadata, options }: ExtensionProviderProps): react_jsx_runtime.JSX.Element;
95
-
96
- export { type CreateExtensionContextOptions, type ExtensionContextReturn, ExtensionProvider, ExtensionProviderProps, createExtensionContext };
package/dist/hooks.d.ts DELETED
@@ -1,96 +0,0 @@
1
- import { ExtensionProviderProps } from './index.js';
2
- export { ErrorHandler, ExtensionContextOptions, ExtensionError, ExtensionLogger, ExtensionMetadata, InfinitePaginationOptions, InfinitePaginationReturn, LoggerOptions, PaginatedResponse, PaginationParams, PaginationState, createExtensionError, createExtensionLogger, env, formatErrorMessage, getApiUrl, handleExtensionError, isClient, isDevelopment, isExtensionError, isProduction, isServer, isStaticBuild, isTest } from './index.js';
3
- export { createExtensionAPI, getSharedAuthStorage } from './api.js';
4
- import { Context, ReactNode, ReactElement } from 'react';
5
- import * as react_jsx_runtime from 'react/jsx-runtime';
6
-
7
- /**
8
- * Utility for creating typed React contexts for extensions
9
- */
10
-
11
- interface CreateExtensionContextOptions<T> {
12
- /** Display name for the context (for debugging) */
13
- displayName: string;
14
- /** Error message when hook is used outside provider */
15
- errorMessage?: string;
16
- }
17
- interface ExtensionContextReturn<T> {
18
- /** The React Context */
19
- Context: Context<T | undefined>;
20
- /** Provider component */
21
- Provider: (props: {
22
- value: T;
23
- children: ReactNode;
24
- }) => ReactElement;
25
- /** Hook to access context value */
26
- useContext: () => T;
27
- }
28
- /**
29
- * Creates a typed React context with provider and hook
30
- *
31
- * @example
32
- * ```tsx
33
- * interface MyContextValue {
34
- * data: string[];
35
- * isLoading: boolean;
36
- * }
37
- *
38
- * const { Provider, useContext } = createExtensionContext<MyContextValue>({
39
- * displayName: 'MyContext'
40
- * });
41
- *
42
- * // In provider component:
43
- * <Provider value={{ data: [], isLoading: false }}>
44
- * {children}
45
- * </Provider>
46
- *
47
- * // In consumer component:
48
- * const { data, isLoading } = useContext();
49
- * ```
50
- */
51
- declare function createExtensionContext<T>({ displayName, errorMessage, }: CreateExtensionContextOptions<T>): ExtensionContextReturn<T>;
52
-
53
- /**
54
- * Base provider with SWR configuration for extension contexts
55
- *
56
- * Provides:
57
- * - SWR configuration for data fetching
58
- * - Extension registration and metadata management
59
- * - Auth context from @djangocfg/api (automatically available via useAuth)
60
- *
61
- * @example
62
- * ```tsx
63
- * // In extension package:
64
- * export function NewsletterProvider({ children }: { children: ReactNode }) {
65
- * return (
66
- * <ExtensionProvider
67
- * metadata={{
68
- * name: 'newsletter',
69
- * version: '1.0.0',
70
- * author: 'DjangoCFG',
71
- * displayName: 'Newsletter',
72
- * description: 'Newsletter subscription management',
73
- * icon: '📧',
74
- * license: 'MIT',
75
- * githubUrl: 'https://github.com/markolofsen/django-cfg',
76
- * keywords: ['newsletter', 'email', 'subscription'],
77
- * }}
78
- * options={{ revalidateOnFocus: true }}
79
- * >
80
- * {children}
81
- * </ExtensionProvider>
82
- * );
83
- * }
84
- *
85
- * // In components:
86
- * import { useAuth } from '@djangocfg/api/auth';
87
- *
88
- * function MyComponent() {
89
- * const { user, isAuthenticated } = useAuth();
90
- * // Auth is automatically available!
91
- * }
92
- * ```
93
- */
94
- declare function ExtensionProvider({ children, metadata, options }: ExtensionProviderProps): react_jsx_runtime.JSX.Element;
95
-
96
- export { type CreateExtensionContextOptions, type ExtensionContextReturn, ExtensionProvider, ExtensionProviderProps, createExtensionContext };