@atomm-developer/generator-workbench 0.1.0 → 0.1.2

package/README.md

@@ -6,8 +6,9 @@ V1 provides:
 
 - Web Component shell
 - login / avatar / logout entry
-- local template import / export entry
-- floating export actions
+- credits badge and export credit hint
+- local template import entry and template publish modal
+- billing-backed export actions
 - runtime panel / canvas mounting
 
 ## Install
@@ -21,7 +22,7 @@ pnpm add @atomm-developer/generator-workbench
 
 ```html
 <script src="https://static-res.atomm.com/scripts/js/generator-sdk/index.umd.js"></script>
-<script src="https://static-res.atomm.com/scripts/js/generator-workbench/index.umd.js"></script>
+<script src="https://static-res.atomm.com/scripts/js/generator-sdk/generator-workbench/index.umd.js"></script>
 ```
 
 ## Usage
@@ -38,6 +39,7 @@ workbench.sdk = sdk
 workbench.runtime = runtime
 workbench.config = {
   title: 'My Generator',
+  mode: 'full',
   templateEnabled: true,
   exportEnabled: true,
   studioEnabled: true,
@@ -46,6 +48,32 @@ workbench.config = {
 await workbench.mount()
 ```
 
+## Shell Modes
+
+- `mode: 'full'` keeps the default shell with the top bar and the sidebar footer export area.
+- `mode: 'template'` hides the top bar, keeps `#sidebar-footer`, and is useful when the host page already owns branding and login UI.
+
+In `template` mode, the host shell can pass an external token into the workbench:
+
+```js
+await workbench.setAuthToken(token)
+```
+
+This writes the token to `localStorage` using the SDK app key and then syncs the login state through `sdk.auth.syncToken(token)`.
+
+## Billing Behavior
+
+- When `sdk.credits` and `sdk.billing` are available, the top bar shows the current credits balance after login.
+- The export trigger shows the current `creditsPerUse` hint from `sdk.billing.getUsage()`.
+- `exportSvg()` and `openInStudio()` now follow the standard generator flow: ensure login first, then call `sdk.billing.consume()`, then perform the export action.
+
+## Template Publish Behavior
+
+- Clicking the top bar template publish action no longer downloads immediately.
+- `generator-workbench` reads `runtime.getPanelSchema()`, renders the generator's own field groups in a modal, and preselects exportable `bind.path` fields.
+- The template JSON is downloaded only after the user confirms the selected fields.
+- `config.getTemplateFieldPaths()` still works as the default subset for the publish modal.
+
 ## Local Preview
 
 ```bash

package/dist/index.d.ts

@@ -1,10 +1,15 @@
 import { AuthStatus } from '@atomm-developer/generator-sdk';
+import { BillingChangeCallback } from '@atomm-developer/generator-sdk';
+import { BillingCheckResult } from '@atomm-developer/generator-sdk';
+import { BillingConsumeOptions } from '@atomm-developer/generator-sdk';
+import { BillingConsumeResult } from '@atomm-developer/generator-sdk';
 import { ExportDownloadResult } from '@atomm-developer/generator-sdk';
 import { ExportOpenInStudioResult } from '@atomm-developer/generator-sdk';
 import { GeneratorTemplateDefinition } from '@atomm-developer/generator-sdk';
 import { PanelFilter } from '@atomm-developer/generator-sdk';
 import { PanelSchema } from '@atomm-developer/generator-sdk';
 import { TemplateBuildOptions } from '@atomm-developer/generator-sdk';
+import { UsageInfo } from '@atomm-developer/generator-sdk';
 import { UserInfo } from '@atomm-developer/generator-sdk';
 
 export declare function defineGeneratorWorkbench(tagName?: string): typeof GeneratorWorkbenchElement;
@@ -33,12 +38,29 @@ export declare interface GeneratorRuntimeLike {
 }
 
 export declare interface GeneratorSDKLike {
+    getAppKey?(): string;
     auth: {
         getStatus(): AuthStatus;
+        syncToken?(token: string): Promise<AuthStatus> | AuthStatus;
         login(): Promise<UserInfo>;
         logout(): Promise<void>;
         onChange(callback: (status: AuthStatus) => void): () => void;
     };
+    credits?: {
+        getBalance(): Promise<{
+            quota: number;
+        }>;
+        getCachedBalance?(): number;
+        onChange?(callback: (balance: number) => void): () => void;
+    };
+    billing?: {
+        getUsage(): Promise<UsageInfo>;
+        getCachedUsage?(): UsageInfo | null;
+        check?(): BillingCheckResult;
+        consume(options?: BillingConsumeOptions): Promise<BillingConsumeResult>;
+        refreshCredits?(): Promise<void>;
+        onChange?(callback: BillingChangeCallback): () => void;
+    };
     template: {
         build(args: TemplateBuildOptions): GeneratorTemplateDefinition;
         parse(text: string): GeneratorTemplateDefinition;
@@ -69,6 +91,7 @@ export declare interface GeneratorWorkbenchActionHookContext {
 
 export declare interface GeneratorWorkbenchConfig {
     title: string;
+    mode?: 'full' | 'template';
     logoText?: string;
     logoUrl?: string;
     logoHref?: string;
@@ -78,6 +101,8 @@ export declare interface GeneratorWorkbenchConfig {
     autoMount?: boolean;
     panelTarget?: 'left' | 'right';
     avatarMenuTrigger?: 'hover' | 'click';
+    /** Override the default atomm-ui CDN CSS URL injected into Shadow DOM */
+    atommUiCssUrl?: string;
     runtimePanelFilter?: PanelFilter;
     getTemplateMeta?: () => Record<string, unknown>;
     getTemplateFieldPaths?: (panelSchema: PanelSchema) => string[];
@@ -90,14 +115,16 @@ export declare class GeneratorWorkbenchElement extends HTMLElement {
     private _sdk;
     private _runtime;
     private _config;
-    private _refs;
     private _mounted;
     private _state;
     private _cleanupAuth?;
+    private _cleanupCredits?;
+    private _cleanupBilling?;
     private _authController?;
     private _templateController?;
     private _exportController?;
     private _runtimeController?;
+    private _shellContext?;
     constructor();
     get sdk(): GeneratorSDKLike | null;
     set sdk(value: GeneratorSDKLike | null);
@@ -112,17 +139,23 @@ export declare class GeneratorWorkbenchElement extends HTMLElement {
     refreshLayout(): void;
     importTemplate(file: File): Promise<void>;
     exportTemplate(): Promise<void>;
+    exportTemplateWithFields(selectedFieldPaths?: string[]): Promise<void>;
     exportSvg(): Promise<void>;
     openInStudio(): Promise<void>;
+    setAuthToken(token: string): Promise<void>;
     private render;
     private bindControllers;
-    private bindShellEvents;
+    private bindShellCallbacks;
+    private openTemplateExportDialog;
+    private closeTemplateExportDialog;
+    private toggleTemplateExportField;
     private bindAuthState;
+    private bindBillingSubscriptions;
     private syncAuthUI;
-    private toggleFabMenu;
-    private toggleAvatarMenu;
-    private setAvatarMenuOpen;
-    private syncMenuUI;
+    private syncBillingUI;
+    private applyBillingUsage;
+    private resetBillingState;
+    private syncBillingState;
     private handleLogin;
     private handleLogout;
     private handleError;