@acmekit/admin-sdk 2.13.1

package/README.md

@@ -0,0 +1 @@
+# @acmekit/admin-sdk

package/dist/index.d.mts

@@ -0,0 +1,55 @@
+import { NestedRoutePosition, InjectionZone } from '@acmekit/admin-shared';
+import { ComponentType } from 'react';
+
+interface WidgetConfig {
+    /**
+     * The injection zone or zones that the widget should be injected into.
+     */
+    zone: InjectionZone | InjectionZone[];
+}
+interface RouteConfig {
+    /**
+     * An optional label to display in the sidebar. If not provided, the route will not be displayed in the sidebar.
+     */
+    label?: string;
+    /**
+     * An optional icon to display in the sidebar together with the label. If no label is provided, the icon will be ignored.
+     */
+    icon?: ComponentType;
+    /**
+     * The nested route to display under existing route in the sidebar.
+     */
+    nested?: NestedRoutePosition;
+    /**
+     * The ranking of the route among sibling routes. Routes are sorted in ascending order (lower rank appears first).
+     * If not provided, the route will be ranked after all routes with explicit ranks.
+     */
+    rank?: number;
+    /**
+     * An optional i18n namespace for translating the label. When provided, the label will be treated as a translation key.
+     * @example
+     * ```ts
+     * label: "menuItems.customFeature"
+     * translationNs: "my-plugin"
+     * // Will translate using: t("menuItems.customFeature", { ns: "my-plugin" })
+     * ```
+     */
+    translationNs?: string;
+}
+
+/**
+ * Define a widget configuration.
+ *
+ * @param config The widget configuration.
+ * @returns The widget configuration.
+ */
+declare function defineWidgetConfig(config: WidgetConfig): WidgetConfig;
+/**
+ * Define a route configuration.
+ *
+ * @param config The route configuration.
+ * @returns The route configuration.
+ */
+declare function defineRouteConfig(config: RouteConfig): RouteConfig;
+
+export { type RouteConfig, type WidgetConfig, defineRouteConfig, defineWidgetConfig };

package/dist/index.d.ts

@@ -0,0 +1,55 @@
+import { NestedRoutePosition, InjectionZone } from '@acmekit/admin-shared';
+import { ComponentType } from 'react';
+
+interface WidgetConfig {
+    /**
+     * The injection zone or zones that the widget should be injected into.
+     */
+    zone: InjectionZone | InjectionZone[];
+}
+interface RouteConfig {
+    /**
+     * An optional label to display in the sidebar. If not provided, the route will not be displayed in the sidebar.
+     */
+    label?: string;
+    /**
+     * An optional icon to display in the sidebar together with the label. If no label is provided, the icon will be ignored.
+     */
+    icon?: ComponentType;
+    /**
+     * The nested route to display under existing route in the sidebar.
+     */
+    nested?: NestedRoutePosition;
+    /**
+     * The ranking of the route among sibling routes. Routes are sorted in ascending order (lower rank appears first).
+     * If not provided, the route will be ranked after all routes with explicit ranks.
+     */
+    rank?: number;
+    /**
+     * An optional i18n namespace for translating the label. When provided, the label will be treated as a translation key.
+     * @example
+     * ```ts
+     * label: "menuItems.customFeature"
+     * translationNs: "my-plugin"
+     * // Will translate using: t("menuItems.customFeature", { ns: "my-plugin" })
+     * ```
+     */
+    translationNs?: string;
+}
+
+/**
+ * Define a widget configuration.
+ *
+ * @param config The widget configuration.
+ * @returns The widget configuration.
+ */
+declare function defineWidgetConfig(config: WidgetConfig): WidgetConfig;
+/**
+ * Define a route configuration.
+ *
+ * @param config The route configuration.
+ * @returns The route configuration.
+ */
+declare function defineRouteConfig(config: RouteConfig): RouteConfig;
+
+export { type RouteConfig, type WidgetConfig, defineRouteConfig, defineWidgetConfig };

package/dist/index.js

@@ -0,0 +1,53 @@
+"use strict";
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __export = (target, all) => {
+  for (var name in all)
+    __defProp(target, name, { get: all[name], enumerable: true });
+};
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+
+// src/index.ts
+var index_exports = {};
+__export(index_exports, {
+  defineRouteConfig: () => defineRouteConfig,
+  defineWidgetConfig: () => defineWidgetConfig
+});
+module.exports = __toCommonJS(index_exports);
+
+// src/config/utils.ts
+var import_zod = require("zod");
+function createConfigHelper(config) {
+  return {
+    ...config,
+    /**
+     * This property is required to allow the config to be exported,
+     * while still allowing HMR to work correctly.
+     *
+     * It tricks Fast Refresh into thinking that the config is a React component,
+     * which allows it to be updated without a full page reload.
+     */
+    $$typeof: Symbol.for("react.memo")
+  };
+}
+function defineWidgetConfig(config) {
+  return createConfigHelper(config);
+}
+function defineRouteConfig(config) {
+  return createConfigHelper(config);
+}
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  defineRouteConfig,
+  defineWidgetConfig
+});

package/dist/index.mjs

@@ -0,0 +1,25 @@
+// src/config/utils.ts
+import { z } from "zod";
+function createConfigHelper(config) {
+  return {
+    ...config,
+    /**
+     * This property is required to allow the config to be exported,
+     * while still allowing HMR to work correctly.
+     *
+     * It tricks Fast Refresh into thinking that the config is a React component,
+     * which allows it to be updated without a full page reload.
+     */
+    $$typeof: Symbol.for("react.memo")
+  };
+}
+function defineWidgetConfig(config) {
+  return createConfigHelper(config);
+}
+function defineRouteConfig(config) {
+  return createConfigHelper(config);
+}
+export {
+  defineRouteConfig,
+  defineWidgetConfig
+};

package/package.json

@@ -0,0 +1,26 @@
+{
+  "name": "@acmekit/admin-sdk",
+  "description": "SDK for building extension for the AcmeKit admin dashboard.",
+  "version": "2.13.1",
+  "author": "Kasper Kristensen <kasper@acmekit.com>",
+  "types": "dist/index.d.ts",
+  "main": "dist/index.js",
+  "module": "dist/index.mjs",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/acmekit/acmekit",
+    "directory": "packages/admin/admin-sdk"
+  },
+  "files": [
+    "dist",
+    "package.json"
+  ],
+  "scripts": {
+    "build": "yarn run -T tsup"
+  },
+  "dependencies": {
+    "@acmekit/admin-shared": "2.13.1",
+    "zod": "3.25.76"
+  },
+  "packageManager": "yarn@3.2.1"
+}