k3-plugin-api 1.6.0 → 2.1.0

package/dist/index.d.cts

@@ -143,8 +143,6 @@ interface K3PluginDescriptor {
     settings: unknown;
     onSave: (settings: unknown) => void;
   }>;
-  /** @deprecated Use viewer.models instead. */
-  dynamicModels?: DynamicModel[];
 }
 interface K3UIExtensions {
   /** Override layout shell components. */
@@ -449,7 +447,7 @@ interface K3ViewerExtensions {
    * Components receive {@link CustomLayoutComponentProps} with BOM and total price data.
    */
   customLayoutComponents?: Record<string, React.ComponentType<CustomLayoutComponentProps>>;
-  /** Dynamic 3D model definitions contributed by this plugin. Equivalent to the top-level `dynamicModels`. */
+  /** Dynamic 3D model definitions contributed by this plugin. */
   models?: DynamicModel[];
   /** Override the label / hotspot overlay components rendered on the 3D canvas. */
   labels?: {
@@ -913,7 +911,5 @@ interface PluginModelContext {
   /** The unique ID of the model action this instance is rendered for. */
   modelActionId?: string;
 }
-/** @deprecated Use K3PluginDescriptor */
-type K3Plugin = Pick<K3PluginDescriptor, "dynamicModels">;
 //#endregion
-export { CallbackWithDescription, CustomLayoutComponentProps, DynamicModel, DynamicModelComponentProps, HOC, HOCWithDescription, K3ARExportContext, K3ARPlatform, K3AppInfo, K3BomEntry, K3Camera, K3CameraScope, K3ComponentInstanceVariables, K3Configuration, K3ConfigurationSavedEvent, K3ConfigurationVariableEntry, K3ConfigurationVariables, K3Coordinates, K3DialogExtensions, K3FullApp, K3InputExtensions, K3LayoutExtensions, K3LogicExtensions, K3NewConfiguration, K3OrderDialogExtensions, K3OrthographicCamera, K3PerspectiveCamera, K3Plugin, K3PluginDescriptor, K3SaveResult, K3Scene, K3ScreenshotDimensions, K3Selection, K3SimplifiedValue, K3UIExtensions, K3UploadFile, K3VariableComponentProps, K3ViewerExtensions, K3WarningExtensions, LocalizedString, ModelProp, ModelPropDefault, PluginModelContext, SlotDefinition, SlotModelInstance, Value, VariableType, VariableTypes, VariableVisualisation, getSettings, init, useApp, useBOM, useConfigurationVariable, useConfigurationVariables, useFormattedTotalPrice, useK3PluginSettings, useTotalPrice };
+export { CallbackWithDescription, CustomLayoutComponentProps, DynamicModel, DynamicModelComponentProps, HOC, HOCWithDescription, K3ARExportContext, K3ARPlatform, K3AppInfo, K3BomEntry, K3Camera, K3CameraScope, K3ComponentInstanceVariables, K3Configuration, K3ConfigurationSavedEvent, K3ConfigurationVariableEntry, K3ConfigurationVariables, K3Coordinates, K3DialogExtensions, K3FullApp, K3InputExtensions, K3LayoutExtensions, K3LogicExtensions, K3NewConfiguration, K3OrderDialogExtensions, K3OrthographicCamera, K3PerspectiveCamera, K3PluginDescriptor, K3SaveResult, K3Scene, K3ScreenshotDimensions, K3Selection, K3SimplifiedValue, K3UIExtensions, K3UploadFile, K3VariableComponentProps, K3ViewerExtensions, K3WarningExtensions, LocalizedString, ModelProp, ModelPropDefault, PluginModelContext, SlotDefinition, SlotModelInstance, Value, VariableType, VariableTypes, VariableVisualisation, getSettings, init, useApp, useBOM, useConfigurationVariable, useConfigurationVariables, useFormattedTotalPrice, useK3PluginSettings, useTotalPrice };

package/dist/index.d.ts

@@ -143,8 +143,6 @@ interface K3PluginDescriptor {
     settings: unknown;
     onSave: (settings: unknown) => void;
   }>;
-  /** @deprecated Use viewer.models instead. */
-  dynamicModels?: DynamicModel[];
 }
 interface K3UIExtensions {
   /** Override layout shell components. */
@@ -449,7 +447,7 @@ interface K3ViewerExtensions {
    * Components receive {@link CustomLayoutComponentProps} with BOM and total price data.
    */
   customLayoutComponents?: Record<string, React.ComponentType<CustomLayoutComponentProps>>;
-  /** Dynamic 3D model definitions contributed by this plugin. Equivalent to the top-level `dynamicModels`. */
+  /** Dynamic 3D model definitions contributed by this plugin. */
   models?: DynamicModel[];
   /** Override the label / hotspot overlay components rendered on the 3D canvas. */
   labels?: {
@@ -913,7 +911,5 @@ interface PluginModelContext {
   /** The unique ID of the model action this instance is rendered for. */
   modelActionId?: string;
 }
-/** @deprecated Use K3PluginDescriptor */
-type K3Plugin = Pick<K3PluginDescriptor, "dynamicModels">;
 //#endregion
-export { CallbackWithDescription, CustomLayoutComponentProps, DynamicModel, DynamicModelComponentProps, HOC, HOCWithDescription, K3ARExportContext, K3ARPlatform, K3AppInfo, K3BomEntry, K3Camera, K3CameraScope, K3ComponentInstanceVariables, K3Configuration, K3ConfigurationSavedEvent, K3ConfigurationVariableEntry, K3ConfigurationVariables, K3Coordinates, K3DialogExtensions, K3FullApp, K3InputExtensions, K3LayoutExtensions, K3LogicExtensions, K3NewConfiguration, K3OrderDialogExtensions, K3OrthographicCamera, K3PerspectiveCamera, K3Plugin, K3PluginDescriptor, K3SaveResult, K3Scene, K3ScreenshotDimensions, K3Selection, K3SimplifiedValue, K3UIExtensions, K3UploadFile, K3VariableComponentProps, K3ViewerExtensions, K3WarningExtensions, LocalizedString, ModelProp, ModelPropDefault, PluginModelContext, SlotDefinition, SlotModelInstance, Value, VariableType, VariableTypes, VariableVisualisation, getSettings, init, useApp, useBOM, useConfigurationVariable, useConfigurationVariables, useFormattedTotalPrice, useK3PluginSettings, useTotalPrice };
+export { CallbackWithDescription, CustomLayoutComponentProps, DynamicModel, DynamicModelComponentProps, HOC, HOCWithDescription, K3ARExportContext, K3ARPlatform, K3AppInfo, K3BomEntry, K3Camera, K3CameraScope, K3ComponentInstanceVariables, K3Configuration, K3ConfigurationSavedEvent, K3ConfigurationVariableEntry, K3ConfigurationVariables, K3Coordinates, K3DialogExtensions, K3FullApp, K3InputExtensions, K3LayoutExtensions, K3LogicExtensions, K3NewConfiguration, K3OrderDialogExtensions, K3OrthographicCamera, K3PerspectiveCamera, K3PluginDescriptor, K3SaveResult, K3Scene, K3ScreenshotDimensions, K3Selection, K3SimplifiedValue, K3UIExtensions, K3UploadFile, K3VariableComponentProps, K3ViewerExtensions, K3WarningExtensions, LocalizedString, ModelProp, ModelPropDefault, PluginModelContext, SlotDefinition, SlotModelInstance, Value, VariableType, VariableTypes, VariableVisualisation, getSettings, init, useApp, useBOM, useConfigurationVariable, useConfigurationVariables, useFormattedTotalPrice, useK3PluginSettings, useTotalPrice };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "k3-plugin-api",
-  "version": "1.6.0",
+  "version": "2.1.0",
   "description": "Official TypeScript types and plugin API for the K3 product configurator",
   "type": "module",
   "main": "dist/index.cjs",
@@ -15,8 +15,12 @@
   },
   "files": [
     "dist",
-    "README.md"
+    "README.md",
+    "scripts"
   ],
+  "bin": {
+    "k3-deploy": "scripts/deploy.js"
+  },
   "keywords": [
     "k3",
     "k3-konfigurator",

package/scripts/deploy.js

@@ -0,0 +1,90 @@
+#!/usr/bin/env node
+import { readFileSync, readdirSync, statSync } from 'node:fs';
+import { join, relative } from 'node:path';
+
+// Minimal .env parser — no dependencies needed
+function loadEnv(path = '.env') {
+  try {
+    for (const line of readFileSync(path, 'utf-8').split('\n')) {
+      const trimmed = line.trim();
+      if (!trimmed || trimmed.startsWith('#')) continue;
+      const eq = trimmed.indexOf('=');
+      if (eq === -1) continue;
+      const key = trimmed.slice(0, eq).trim();
+      const val = trimmed.slice(eq + 1).trim().replace(/^['"]|['"]$/g, '');
+      if (!process.env[key]) process.env[key] = val;
+    }
+  } catch { /* .env is optional */ }
+}
+
+loadEnv();
+
+const {
+  API_TOKEN,
+  PLUGIN_ID,
+  BACKEND_URL = 'https://k3-api.objectcode.de',
+  FEDERATION_NAME,
+  FEDERATION_MODULE,
+} = process.env;
+
+if (!API_TOKEN) { console.error('Error: API_TOKEN missing in .env'); process.exit(1); }
+if (!PLUGIN_ID) { console.error('Error: PLUGIN_ID missing in .env'); process.exit(1); }
+
+function collectFiles(dir, base = dir) {
+  const results = [];
+  for (const entry of readdirSync(dir)) {
+    const full = join(dir, entry);
+    if (statSync(full).isDirectory()) {
+      results.push(...collectFiles(full, base));
+    } else {
+      results.push({ full, rel: relative(base, full) });
+    }
+  }
+  return results;
+}
+
+const distPath = join(process.cwd(), 'dist');
+let files;
+try {
+  files = collectFiles(distPath);
+} catch {
+  console.error('Error: dist/ not found. Run pnpm build first.');
+  process.exit(1);
+}
+
+console.log(`Deploying ${files.length} files for plugin ${PLUGIN_ID}...`);
+
+const form = new FormData();
+
+for (const { full, rel } of files) {
+  // PHP converts '.' in multipart field names to '_'. To avoid this and
+  // collisions with Vite chunk names (which contain '__'), we base64url-encode
+  // the full relative path as the field key.
+  const key = 'f_' + Buffer.from(rel).toString('base64').replaceAll('+', '-').replaceAll('/', '_').replaceAll('=', '');
+  const blob = new Blob([readFileSync(full)]);
+  form.append(key, blob, rel.split('/').pop());
+}
+
+if (FEDERATION_NAME)   form.append('name',   FEDERATION_NAME);
+if (FEDERATION_MODULE) form.append('module', FEDERATION_MODULE);
+
+const url = `${BACKEND_URL}/api/v1.0/plugin/${PLUGIN_ID}/deploy`;
+console.log(`POST ${url}`);
+
+const res = await fetch(url, {
+  method: 'POST',
+  headers: { Authorization: `Bearer ${API_TOKEN}` },
+  body: form,
+});
+
+if (!res.ok) {
+  const text = await res.text();
+  console.error(`Deploy failed (${res.status}): ${text}`);
+  process.exit(1);
+}
+
+const result = await res.json();
+console.log('');
+console.log('✓ Deploy successful!');
+console.log('  Version:', result.versionId);
+console.log('  URL:    ', result.url);