talearchitect-api 1.0.0 → 1.1.0

package/README.md

@@ -5,7 +5,7 @@
 
 Este pacote contém as definições de tipo TypeScript (`.d.ts`) para o desenvolvimento de plugins para o **TaleArchitect**.
 
-Ao instalar este pacote, seu editor de código (VS Code, etc.) fornecerá **Autocomplete (IntelliSense)**, documentação inline e verificação de tipos para a variável global `app`.
+Ao instalar este pacote, seu editor de código (VS Code, etc.) fornecerá **Autocomplete (IntelliSense)**, documentação inline e verificação de tipos para a variável `app`.
 
 > **Nota:** Este pacote contém apenas tipos. A lógica de execução é fornecida nativamente pelo aplicativo TaleArchitect.
 
@@ -47,7 +47,19 @@ Crie um arquivo jsconfig.json na raiz da pasta do seu plugin. Isso habilita o au
 ```
 
 ## 📚 Visão Geral da API
-O objeto global app expõe as seguintes funcionalidades:
+
+### Ponto de partida
+Seu script deve conter uma função `init(app)`, que atuará como uma função "main" do seu plugin.
+
+```bash
+function init(app) {
+  app.ui.toast("Hello, World!", "success");
+}
+```
+
+<hr>
+
+O objeto `app` passado em `init(app)` expõe as seguintes funcionalidades:
 
 ```app.commands```
 
@@ -97,4 +109,16 @@ Descubra o estado atual da interface (qual aba está ativa, nível de zoom, etc)
 if (app.context.getActiveTab() === 'map') { ... }
 ```
 
+```app.metadata```
+
+Permite salvar e recuperar dados personalizados em entidades (locais, conexões, eventos ou personagens).
+```bash
+const id = await app.factory.createCharacter("Novo Herói");
+app.metadata.set(id, {
+  hp: 20,
+  ataque: 4,
+  velocidade: 10
+});
+```
+
 https://github.com/MateusRNM/TaleArchitect - Repositório principal do aplicativo.

package/index.d.ts

@@ -24,7 +24,6 @@ export interface Character {
     image: string | null;
     description: string;
     createdAt: string;
-    [key: string]: any;
 }
 
 export interface Location {
@@ -32,7 +31,6 @@ export interface Location {
     name: string;
     description: string;
     coordinates: Coordinates;
-    [key: string]: any;
 }
 
 export interface Connection {
@@ -41,7 +39,6 @@ export interface Connection {
     description: string;
     fromLocationId: UUID;
     toLocationId: UUID;
-    [key: string]: any;
 }
 
 export interface Event {
@@ -51,7 +48,6 @@ export interface Event {
     locationId: UUID;
     date: Time;
     characters: UUID[];
-    [key: string]: any;
 }
 
 export interface MapView {
@@ -67,7 +63,7 @@ export interface MapStateSnapshot {
 }
 
 export interface TimelineStateSnapshot {
-    view: 'list' | 'form';
+    view: 'list' | 'swimlane' | 'form';
     selectedEventId: string | null;
     scrollY: number;
 }
@@ -81,7 +77,8 @@ export type ToastType = 'success' | 'error' | 'info';
 
 export interface AppAPI {
 
-    readonly version: string;
+    readonly apiVersion: string;
+    readonly pluginInfo: { id: string };
 
     commands: {
         execute(id: string, args?: any): Promise<void>;
@@ -95,6 +92,15 @@ export interface AppAPI {
         getEvents(): Promise<Event[]>;
         getCalendar(): Promise<{ months: Month[] }>;
         getCurrentDate(): Promise<Time | null>;
+        updateCharacter(id: string, changes: Partial<Character>): Promise<void>;
+        updateLocation(id: string, changes: Partial<Location>): Promise<void>;
+        updateEvent(id: string, changes: Partial<Event>): Promise<void>;
+        updateConnection(id: string, changes: Partial<Character>): Promise<void>;
+        updateCalendar(months: Month[]): Promise<void>;
+        removeCharacter(id: string): Promise<void>;
+        removeLocation(id: string): Promise<void>;
+        removeEvent(id: string): Promise<void>;
+        removeConnection(id: string): Promise<void>;
     };
 
     factory: {
@@ -117,10 +123,11 @@ export interface AppAPI {
         getActiveTab(): string;
         getStates(): FullUIState;
     };
-}
 
-declare global {
-    const app: AppAPI;
+    metadata: {
+        get(entityId: string): Promise<any>,
+        set(entityId: string, data: any): Promise<void>
+    };
 }
 
 export {};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "talearchitect-api",
-  "version": "1.0.0",
+  "version": "1.1.0",
   "description": "Type definitions for TaleArchitect plugins",
   "types": "index.d.ts",
   "scripts": {