@djangocfg/ext-base 1.0.0

package/dist/hooks.cjs

@@ -0,0 +1,190 @@
+'use strict';
+
+var consola = require('consola');
+var react = require('react');
+var jsxRuntime = require('react/jsx-runtime');
+var swr = require('swr');
+
+var __require = /* @__PURE__ */ ((x) => typeof require !== "undefined" ? require : typeof Proxy !== "undefined" ? new Proxy(x, {
+  get: (a, b) => (typeof require !== "undefined" ? require : a)[b]
+}) : x)(function(x) {
+  if (typeof require !== "undefined") return require.apply(this, arguments);
+  throw Error('Dynamic require of "' + x + '" is not supported');
+});
+
+// src/config/env.ts
+var isDevelopment = process.env.NODE_ENV === "development";
+var isProduction = process.env.NODE_ENV === "production";
+var isTest = process.env.NODE_ENV === "test";
+var isStaticBuild = process.env.NEXT_PUBLIC_STATIC_BUILD === "true";
+var isClient = typeof window !== "undefined";
+var isServer = !isClient;
+var getApiUrl = () => {
+  return process.env.NEXT_PUBLIC_API_URL || "";
+};
+var env = {
+  isDevelopment,
+  isProduction,
+  isTest,
+  isStaticBuild,
+  isClient,
+  isServer,
+  getApiUrl
+};
+
+// src/api/createExtensionAPI.ts
+function createExtensionAPI(APIClass) {
+  let storage;
+  try {
+    const { api: accountsApi } = __require("@djangocfg/api");
+    storage = accountsApi._storage;
+  } catch (error) {
+    storage = void 0;
+  }
+  const apiUrl = isStaticBuild ? "" : getApiUrl();
+  return new APIClass(apiUrl, storage ? { storage } : void 0);
+}
+function getSharedAuthStorage() {
+  try {
+    const { api: accountsApi } = __require("@djangocfg/api");
+    return accountsApi._storage;
+  } catch (error) {
+    return void 0;
+  }
+}
+
+// src/utils/errors.ts
+function isExtensionError(error) {
+  return typeof error === "object" && error !== null && "message" in error && "timestamp" in error;
+}
+function createExtensionError(error, code, details) {
+  const message = error instanceof Error ? error.message : String(error);
+  return {
+    message,
+    code,
+    details,
+    timestamp: (/* @__PURE__ */ new Date()).toISOString()
+  };
+}
+function formatErrorMessage(error) {
+  if (isExtensionError(error)) {
+    return error.code ? `[${error.code}] ${error.message}` : error.message;
+  }
+  if (error instanceof Error) {
+    return error.message;
+  }
+  return String(error);
+}
+function handleExtensionError(error, logger, callback) {
+  const extensionError = isExtensionError(error) ? error : createExtensionError(error);
+  if (logger) {
+    logger.error("Extension error:", extensionError);
+  }
+  if (callback) {
+    callback(extensionError);
+  }
+}
+var isDevelopment2 = process.env.NODE_ENV === "development";
+var LEVEL_MAP = {
+  debug: 4,
+  info: 3,
+  warn: 2,
+  error: 1
+};
+function createExtensionLogger(options) {
+  const { tag, level = "info", enabled = true } = options;
+  if (!enabled) {
+    const noop = () => {
+    };
+    return {
+      info: noop,
+      warn: noop,
+      error: noop,
+      debug: noop,
+      success: noop
+    };
+  }
+  const logLevel = isDevelopment2 ? LEVEL_MAP[level] : LEVEL_MAP.error;
+  const consola$1 = consola.createConsola({
+    level: logLevel
+  }).withTag(tag);
+  return {
+    info: (...args) => consola$1.info(...args),
+    warn: (...args) => consola$1.warn(...args),
+    error: (...args) => consola$1.error(...args),
+    debug: (...args) => consola$1.debug(...args),
+    success: (...args) => consola$1.success(...args)
+  };
+}
+function createExtensionContext({
+  displayName,
+  errorMessage
+}) {
+  const Context = react.createContext(void 0);
+  Context.displayName = displayName;
+  const Provider = ({ value, children }) => {
+    return /* @__PURE__ */ jsxRuntime.jsx(Context.Provider, { value, children });
+  };
+  const useContextHook = () => {
+    const context = react.useContext(Context);
+    if (context === void 0) {
+      throw new Error(
+        errorMessage || `use${displayName} must be used within ${displayName}Provider`
+      );
+    }
+    return context;
+  };
+  return {
+    Context,
+    Provider,
+    useContext: useContextHook
+  };
+}
+var DEFAULT_OPTIONS = {
+  revalidateOnFocus: false,
+  revalidateOnReconnect: false,
+  revalidateIfStale: false
+};
+var registeredExtensions = /* @__PURE__ */ new Set();
+function ExtensionProvider({ children, metadata, options = {} }) {
+  const config = { ...DEFAULT_OPTIONS, ...options };
+  react.useEffect(() => {
+    if (registeredExtensions.has(metadata.name)) {
+      if (isDevelopment) {
+        console.warn(
+          `[ExtensionProvider] Extension "${metadata.name}" is already registered. This might indicate that the extension is mounted multiple times.`
+        );
+      }
+      return;
+    }
+    registeredExtensions.add(metadata.name);
+    if (isDevelopment) {
+      const logger = createExtensionLogger({ tag: "ext-base", level: "info" });
+      logger.info(
+        `Extension registered: ${metadata.displayName || metadata.name} v${metadata.version}`
+      );
+    }
+    return () => {
+      registeredExtensions.delete(metadata.name);
+    };
+  }, [metadata.name, metadata.version, metadata.displayName]);
+  return /* @__PURE__ */ jsxRuntime.jsx(swr.SWRConfig, { value: config, children });
+}
+
+exports.ExtensionProvider = ExtensionProvider;
+exports.createExtensionAPI = createExtensionAPI;
+exports.createExtensionContext = createExtensionContext;
+exports.createExtensionError = createExtensionError;
+exports.createExtensionLogger = createExtensionLogger;
+exports.env = env;
+exports.formatErrorMessage = formatErrorMessage;
+exports.getApiUrl = getApiUrl;
+exports.getSharedAuthStorage = getSharedAuthStorage;
+exports.handleExtensionError = handleExtensionError;
+exports.isClient = isClient;
+exports.isDevelopment = isDevelopment;
+exports.isExtensionError = isExtensionError;
+exports.isProduction = isProduction;
+exports.isServer = isServer;
+exports.isStaticBuild = isStaticBuild;
+exports.isTest = isTest;

package/dist/hooks.d.cts

@@ -0,0 +1,96 @@
+import { ExtensionProviderProps } from './index.cjs';
+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';
+export { createExtensionAPI, getSharedAuthStorage } from './api.cjs';
+import { Context, ReactNode, ReactElement } from 'react';
+import * as react_jsx_runtime from 'react/jsx-runtime';
+
+/**
+ * Utility for creating typed React contexts for extensions
+ */
+
+interface CreateExtensionContextOptions<T> {
+    /** Display name for the context (for debugging) */
+    displayName: string;
+    /** Error message when hook is used outside provider */
+    errorMessage?: string;
+}
+interface ExtensionContextReturn<T> {
+    /** The React Context */
+    Context: Context<T | undefined>;
+    /** Provider component */
+    Provider: (props: {
+        value: T;
+        children: ReactNode;
+    }) => ReactElement;
+    /** Hook to access context value */
+    useContext: () => T;
+}
+/**
+ * Creates a typed React context with provider and hook
+ *
+ * @example
+ * ```tsx
+ * interface MyContextValue {
+ *   data: string[];
+ *   isLoading: boolean;
+ * }
+ *
+ * const { Provider, useContext } = createExtensionContext<MyContextValue>({
+ *   displayName: 'MyContext'
+ * });
+ *
+ * // In provider component:
+ * <Provider value={{ data: [], isLoading: false }}>
+ *   {children}
+ * </Provider>
+ *
+ * // In consumer component:
+ * const { data, isLoading } = useContext();
+ * ```
+ */
+declare function createExtensionContext<T>({ displayName, errorMessage, }: CreateExtensionContextOptions<T>): ExtensionContextReturn<T>;
+
+/**
+ * Base provider with SWR configuration for extension contexts
+ *
+ * Provides:
+ * - SWR configuration for data fetching
+ * - Extension registration and metadata management
+ * - Auth context from @djangocfg/api (automatically available via useAuth)
+ *
+ * @example
+ * ```tsx
+ * // In extension package:
+ * export function NewsletterProvider({ children }: { children: ReactNode }) {
+ *   return (
+ *     <ExtensionProvider
+ *       metadata={{
+ *         name: 'newsletter',
+ *         version: '1.0.0',
+ *         author: 'DjangoCFG',
+ *         displayName: 'Newsletter',
+ *         description: 'Newsletter subscription management',
+ *         icon: '📧',
+ *         license: 'MIT',
+ *         githubUrl: 'https://github.com/markolofsen/django-cfg',
+ *         keywords: ['newsletter', 'email', 'subscription'],
+ *       }}
+ *       options={{ revalidateOnFocus: true }}
+ *     >
+ *       {children}
+ *     </ExtensionProvider>
+ *   );
+ * }
+ *
+ * // In components:
+ * import { useAuth } from '@djangocfg/api/auth';
+ *
+ * function MyComponent() {
+ *   const { user, isAuthenticated } = useAuth();
+ *   // Auth is automatically available!
+ * }
+ * ```
+ */
+declare function ExtensionProvider({ children, metadata, options }: ExtensionProviderProps): react_jsx_runtime.JSX.Element;
+
+export { type CreateExtensionContextOptions, type ExtensionContextReturn, ExtensionProvider, ExtensionProviderProps, createExtensionContext };

package/dist/hooks.d.ts

@@ -0,0 +1,96 @@
+import { ExtensionProviderProps } from './index.js';
+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';
+export { createExtensionAPI, getSharedAuthStorage } from './api.js';
+import { Context, ReactNode, ReactElement } from 'react';
+import * as react_jsx_runtime from 'react/jsx-runtime';
+
+/**
+ * Utility for creating typed React contexts for extensions
+ */
+
+interface CreateExtensionContextOptions<T> {
+    /** Display name for the context (for debugging) */
+    displayName: string;
+    /** Error message when hook is used outside provider */
+    errorMessage?: string;
+}
+interface ExtensionContextReturn<T> {
+    /** The React Context */
+    Context: Context<T | undefined>;
+    /** Provider component */
+    Provider: (props: {
+        value: T;
+        children: ReactNode;
+    }) => ReactElement;
+    /** Hook to access context value */
+    useContext: () => T;
+}
+/**
+ * Creates a typed React context with provider and hook
+ *
+ * @example
+ * ```tsx
+ * interface MyContextValue {
+ *   data: string[];
+ *   isLoading: boolean;
+ * }
+ *
+ * const { Provider, useContext } = createExtensionContext<MyContextValue>({
+ *   displayName: 'MyContext'
+ * });
+ *
+ * // In provider component:
+ * <Provider value={{ data: [], isLoading: false }}>
+ *   {children}
+ * </Provider>
+ *
+ * // In consumer component:
+ * const { data, isLoading } = useContext();
+ * ```
+ */
+declare function createExtensionContext<T>({ displayName, errorMessage, }: CreateExtensionContextOptions<T>): ExtensionContextReturn<T>;
+
+/**
+ * Base provider with SWR configuration for extension contexts
+ *
+ * Provides:
+ * - SWR configuration for data fetching
+ * - Extension registration and metadata management
+ * - Auth context from @djangocfg/api (automatically available via useAuth)
+ *
+ * @example
+ * ```tsx
+ * // In extension package:
+ * export function NewsletterProvider({ children }: { children: ReactNode }) {
+ *   return (
+ *     <ExtensionProvider
+ *       metadata={{
+ *         name: 'newsletter',
+ *         version: '1.0.0',
+ *         author: 'DjangoCFG',
+ *         displayName: 'Newsletter',
+ *         description: 'Newsletter subscription management',
+ *         icon: '📧',
+ *         license: 'MIT',
+ *         githubUrl: 'https://github.com/markolofsen/django-cfg',
+ *         keywords: ['newsletter', 'email', 'subscription'],
+ *       }}
+ *       options={{ revalidateOnFocus: true }}
+ *     >
+ *       {children}
+ *     </ExtensionProvider>
+ *   );
+ * }
+ *
+ * // In components:
+ * import { useAuth } from '@djangocfg/api/auth';
+ *
+ * function MyComponent() {
+ *   const { user, isAuthenticated } = useAuth();
+ *   // Auth is automatically available!
+ * }
+ * ```
+ */
+declare function ExtensionProvider({ children, metadata, options }: ExtensionProviderProps): react_jsx_runtime.JSX.Element;
+
+export { type CreateExtensionContextOptions, type ExtensionContextReturn, ExtensionProvider, ExtensionProviderProps, createExtensionContext };

package/dist/hooks.js

@@ -0,0 +1,65 @@
+import { createExtensionLogger } from './chunk-YQGNYUBX.js';
+export { createExtensionError, createExtensionLogger, formatErrorMessage, handleExtensionError, isExtensionError } from './chunk-YQGNYUBX.js';
+import { isDevelopment } from './chunk-MECBWZG4.js';
+export { createExtensionAPI, env, getApiUrl, getSharedAuthStorage, isClient, isDevelopment, isProduction, isServer, isStaticBuild, isTest } from './chunk-MECBWZG4.js';
+import './chunk-3RG5ZIWI.js';
+import { createContext, useEffect, useContext } from 'react';
+import { jsx } from 'react/jsx-runtime';
+import { SWRConfig } from 'swr';
+
+function createExtensionContext({
+  displayName,
+  errorMessage
+}) {
+  const Context = createContext(void 0);
+  Context.displayName = displayName;
+  const Provider = ({ value, children }) => {
+    return /* @__PURE__ */ jsx(Context.Provider, { value, children });
+  };
+  const useContextHook = () => {
+    const context = useContext(Context);
+    if (context === void 0) {
+      throw new Error(
+        errorMessage || `use${displayName} must be used within ${displayName}Provider`
+      );
+    }
+    return context;
+  };
+  return {
+    Context,
+    Provider,
+    useContext: useContextHook
+  };
+}
+var DEFAULT_OPTIONS = {
+  revalidateOnFocus: false,
+  revalidateOnReconnect: false,
+  revalidateIfStale: false
+};
+var registeredExtensions = /* @__PURE__ */ new Set();
+function ExtensionProvider({ children, metadata, options = {} }) {
+  const config = { ...DEFAULT_OPTIONS, ...options };
+  useEffect(() => {
+    if (registeredExtensions.has(metadata.name)) {
+      if (isDevelopment) {
+        console.warn(
+          `[ExtensionProvider] Extension "${metadata.name}" is already registered. This might indicate that the extension is mounted multiple times.`
+        );
+      }
+      return;
+    }
+    registeredExtensions.add(metadata.name);
+    if (isDevelopment) {
+      const logger = createExtensionLogger({ tag: "ext-base", level: "info" });
+      logger.info(
+        `Extension registered: ${metadata.displayName || metadata.name} v${metadata.version}`
+      );
+    }
+    return () => {
+      registeredExtensions.delete(metadata.name);
+    };
+  }, [metadata.name, metadata.version, metadata.displayName]);
+  return /* @__PURE__ */ jsx(SWRConfig, { value: config, children });
+}
+
+export { ExtensionProvider, createExtensionContext };

package/dist/index.cjs

@@ -0,0 +1,131 @@
+'use strict';
+
+var consola = require('consola');
+
+var __require = /* @__PURE__ */ ((x) => typeof require !== "undefined" ? require : typeof Proxy !== "undefined" ? new Proxy(x, {
+  get: (a, b) => (typeof require !== "undefined" ? require : a)[b]
+}) : x)(function(x) {
+  if (typeof require !== "undefined") return require.apply(this, arguments);
+  throw Error('Dynamic require of "' + x + '" is not supported');
+});
+
+// src/config/env.ts
+var isDevelopment = process.env.NODE_ENV === "development";
+var isProduction = process.env.NODE_ENV === "production";
+var isTest = process.env.NODE_ENV === "test";
+var isStaticBuild = process.env.NEXT_PUBLIC_STATIC_BUILD === "true";
+var isClient = typeof window !== "undefined";
+var isServer = !isClient;
+var getApiUrl = () => {
+  return process.env.NEXT_PUBLIC_API_URL || "";
+};
+var env = {
+  isDevelopment,
+  isProduction,
+  isTest,
+  isStaticBuild,
+  isClient,
+  isServer,
+  getApiUrl
+};
+
+// src/api/createExtensionAPI.ts
+function createExtensionAPI(APIClass) {
+  let storage;
+  try {
+    const { api: accountsApi } = __require("@djangocfg/api");
+    storage = accountsApi._storage;
+  } catch (error) {
+    storage = void 0;
+  }
+  const apiUrl = isStaticBuild ? "" : getApiUrl();
+  return new APIClass(apiUrl, storage ? { storage } : void 0);
+}
+function getSharedAuthStorage() {
+  try {
+    const { api: accountsApi } = __require("@djangocfg/api");
+    return accountsApi._storage;
+  } catch (error) {
+    return void 0;
+  }
+}
+
+// src/utils/errors.ts
+function isExtensionError(error) {
+  return typeof error === "object" && error !== null && "message" in error && "timestamp" in error;
+}
+function createExtensionError(error, code, details) {
+  const message = error instanceof Error ? error.message : String(error);
+  return {
+    message,
+    code,
+    details,
+    timestamp: (/* @__PURE__ */ new Date()).toISOString()
+  };
+}
+function formatErrorMessage(error) {
+  if (isExtensionError(error)) {
+    return error.code ? `[${error.code}] ${error.message}` : error.message;
+  }
+  if (error instanceof Error) {
+    return error.message;
+  }
+  return String(error);
+}
+function handleExtensionError(error, logger, callback) {
+  const extensionError = isExtensionError(error) ? error : createExtensionError(error);
+  if (logger) {
+    logger.error("Extension error:", extensionError);
+  }
+  if (callback) {
+    callback(extensionError);
+  }
+}
+var isDevelopment2 = process.env.NODE_ENV === "development";
+var LEVEL_MAP = {
+  debug: 4,
+  info: 3,
+  warn: 2,
+  error: 1
+};
+function createExtensionLogger(options) {
+  const { tag, level = "info", enabled = true } = options;
+  if (!enabled) {
+    const noop = () => {
+    };
+    return {
+      info: noop,
+      warn: noop,
+      error: noop,
+      debug: noop,
+      success: noop
+    };
+  }
+  const logLevel = isDevelopment2 ? LEVEL_MAP[level] : LEVEL_MAP.error;
+  const consola$1 = consola.createConsola({
+    level: logLevel
+  }).withTag(tag);
+  return {
+    info: (...args) => consola$1.info(...args),
+    warn: (...args) => consola$1.warn(...args),
+    error: (...args) => consola$1.error(...args),
+    debug: (...args) => consola$1.debug(...args),
+    success: (...args) => consola$1.success(...args)
+  };
+}
+
+exports.createExtensionAPI = createExtensionAPI;
+exports.createExtensionError = createExtensionError;
+exports.createExtensionLogger = createExtensionLogger;
+exports.env = env;
+exports.formatErrorMessage = formatErrorMessage;
+exports.getApiUrl = getApiUrl;
+exports.getSharedAuthStorage = getSharedAuthStorage;
+exports.handleExtensionError = handleExtensionError;
+exports.isClient = isClient;
+exports.isDevelopment = isDevelopment;
+exports.isExtensionError = isExtensionError;
+exports.isProduction = isProduction;
+exports.isServer = isServer;
+exports.isStaticBuild = isStaticBuild;
+exports.isTest = isTest;