@zhama/tego-plugin-sdk 0.0.0-stage → 1.36.1

package/dist/publish.d.cts

@@ -0,0 +1,96 @@
+import { PackedPlugin } from './pack.cjs';
+import './manifest-types-DQARCQJt.cjs';
+
+interface PublishPluginOptions {
+    /** Package root: the directory holding `tego.plugin.json`. */
+    root: string;
+    /** Server origin, e.g. `http://localhost:3100`. Trailing slashes are trimmed. */
+    server: string;
+    /** Admin bearer token. The publish endpoints all sit behind `adminMiddleware`. */
+    token: string;
+    /**
+     * Avatars to install onto, for an avatar-scoped plugin. An empty array
+     * installs it for nobody, which is the server's own contract, not a no-op —
+     * it still creates the tenant install. Ignored for a tenant-scoped plugin.
+     */
+    avatarIds?: string[];
+    /** Catalog metadata to stamp on the release. */
+    meta?: {
+        category?: string;
+        homepage?: string;
+        icon?: string;
+    };
+    /** Approve the release after finalizing it. Defaults to true. */
+    approve?: boolean;
+    /** Install onto the tenant after approving. Defaults to true. */
+    install?: boolean;
+    /** Where to report progress. Defaults to `console.log`. Pass `null` to mute. */
+    log?: ((message: string) => void) | null;
+    /** Injectable for tests; defaults to Node's global `fetch`. */
+    fetchImpl?: typeof fetch;
+}
+interface PackagePreview {
+    pluginId: string;
+    semanticVersion: string;
+    displayName: string;
+    isUpgrade: boolean;
+    requiresConfig: boolean;
+    parts: {
+        frontend?: {
+            entryPath: string;
+            locales: string[];
+            navCount: number;
+        };
+        backend?: {
+            entryPath: string;
+            migrationCount: number;
+        };
+        claw?: {
+            entryPath: string;
+        };
+    };
+}
+interface CatalogItem {
+    id: string;
+    pluginId: string;
+    displayName: string;
+}
+interface Release {
+    id: string;
+    pluginId: string;
+    semanticVersion: string;
+    packageSha256: string;
+    status: 'draft' | 'approved' | 'retired' | 'revoked';
+}
+interface TenantInstall {
+    pluginId: string;
+    releaseId: string;
+    version: string;
+    scope: 'avatar' | 'tenant';
+    enabled: boolean;
+    avatarIds: string[];
+    avatars?: {
+        attempted: number;
+        failures: {
+            avatarId: string;
+            message: string;
+        }[];
+    };
+}
+interface PublishResult {
+    packed: PackedPlugin;
+    preview: PackagePreview;
+    catalog: CatalogItem;
+    release: Release;
+    /** Present unless install was disabled. */
+    install: TenantInstall | null;
+}
+declare function publishPlugin(options: PublishPluginOptions): Promise<PublishResult>;
+/**
+ * The network half of `publishPlugin`, split out so the sequence can be
+ * exercised without a real `vite`/`esbuild` pack: presign → upload → inspect →
+ * finalize → approve → install, against an already-built archive on disk.
+ */
+declare function publishPackedPlugin(packed: PackedPlugin, options: Omit<PublishPluginOptions, 'root'>): Promise<PublishResult>;
+
+export { type PublishPluginOptions, type PublishResult, publishPackedPlugin, publishPlugin };

package/dist/publish.d.ts

@@ -0,0 +1,96 @@
+import { PackedPlugin } from './pack.js';
+import './manifest-types-DQARCQJt.js';
+
+interface PublishPluginOptions {
+    /** Package root: the directory holding `tego.plugin.json`. */
+    root: string;
+    /** Server origin, e.g. `http://localhost:3100`. Trailing slashes are trimmed. */
+    server: string;
+    /** Admin bearer token. The publish endpoints all sit behind `adminMiddleware`. */
+    token: string;
+    /**
+     * Avatars to install onto, for an avatar-scoped plugin. An empty array
+     * installs it for nobody, which is the server's own contract, not a no-op —
+     * it still creates the tenant install. Ignored for a tenant-scoped plugin.
+     */
+    avatarIds?: string[];
+    /** Catalog metadata to stamp on the release. */
+    meta?: {
+        category?: string;
+        homepage?: string;
+        icon?: string;
+    };
+    /** Approve the release after finalizing it. Defaults to true. */
+    approve?: boolean;
+    /** Install onto the tenant after approving. Defaults to true. */
+    install?: boolean;
+    /** Where to report progress. Defaults to `console.log`. Pass `null` to mute. */
+    log?: ((message: string) => void) | null;
+    /** Injectable for tests; defaults to Node's global `fetch`. */
+    fetchImpl?: typeof fetch;
+}
+interface PackagePreview {
+    pluginId: string;
+    semanticVersion: string;
+    displayName: string;
+    isUpgrade: boolean;
+    requiresConfig: boolean;
+    parts: {
+        frontend?: {
+            entryPath: string;
+            locales: string[];
+            navCount: number;
+        };
+        backend?: {
+            entryPath: string;
+            migrationCount: number;
+        };
+        claw?: {
+            entryPath: string;
+        };
+    };
+}
+interface CatalogItem {
+    id: string;
+    pluginId: string;
+    displayName: string;
+}
+interface Release {
+    id: string;
+    pluginId: string;
+    semanticVersion: string;
+    packageSha256: string;
+    status: 'draft' | 'approved' | 'retired' | 'revoked';
+}
+interface TenantInstall {
+    pluginId: string;
+    releaseId: string;
+    version: string;
+    scope: 'avatar' | 'tenant';
+    enabled: boolean;
+    avatarIds: string[];
+    avatars?: {
+        attempted: number;
+        failures: {
+            avatarId: string;
+            message: string;
+        }[];
+    };
+}
+interface PublishResult {
+    packed: PackedPlugin;
+    preview: PackagePreview;
+    catalog: CatalogItem;
+    release: Release;
+    /** Present unless install was disabled. */
+    install: TenantInstall | null;
+}
+declare function publishPlugin(options: PublishPluginOptions): Promise<PublishResult>;
+/**
+ * The network half of `publishPlugin`, split out so the sequence can be
+ * exercised without a real `vite`/`esbuild` pack: presign → upload → inspect →
+ * finalize → approve → install, against an already-built archive on disk.
+ */
+declare function publishPackedPlugin(packed: PackedPlugin, options: Omit<PublishPluginOptions, 'root'>): Promise<PublishResult>;
+
+export { type PublishPluginOptions, type PublishResult, publishPackedPlugin, publishPlugin };

package/dist/publish.js

@@ -0,0 +1 @@
+var h=Object.defineProperty;var o=(e,a)=>h(e,"name",{value:a,configurable:!0});import{packPlugin as v}from"./chunk-3KUOBGJN.js";import"./chunk-7K37PVGV.js";import"./chunk-5CU33JVY.js";import{resolvePluginScope as P}from"./chunk-BTHXQWHT.js";import"./chunk-7XHF3YSK.js";import"./chunk-VMCGDDGP.js";import"./chunk-SNUCO2MK.js";import{readFile as w}from"fs/promises";import{basename as y}from"path";var I="/api/v1/tego-os";async function T(e){const a=e.log===null?()=>{}:e.log??(n=>console.log(n)),t=await v({root:e.root,log:a});return f(t,e)}o(T,"publishPlugin");async function f(e,a){const t=a.log===null?()=>{}:a.log??(p=>console.log(p)),n=a.fetchImpl??fetch,r=A(a.server,a.token,n),s=await w(e.file),c=y(e.file);t("\u203A presigning upload");const u=await r("POST","/admin/runtime-plugins/presign-stream",{filename:c,mimeType:"application/zip",size:s.byteLength});t(`\u203A uploading ${c} (${s.byteLength} bytes)`),await S(a.server,u.uploadUrl,s,n),t("\u203A inspecting package");const l=await r("POST","/admin/runtime-plugins/inspect",{uploadToken:u.uploadToken});t(`  ${l.pluginId}@${l.semanticVersion} \u2014 ${b(l)}${l.isUpgrade?" (upgrade)":""}${l.requiresConfig?", needs config":""}`),t("\u203A finalizing release");const g=await r("POST","/admin/runtime-plugins/upload",{uploadToken:u.uploadToken,...a.meta});let i=g.release;t(`  release ${i.id} (${i.status})`),(a.approve??!0)&&(t("\u203A approving release"),i=await r("POST",`/admin/runtime-plugins/releases/${encodeURIComponent(i.id)}/approve`,{}),t(`  release ${i.id} (${i.status})`));let d=null;if(a.install??!0){const p=P(e.manifest),$=p==="avatar"?{releaseId:i.id,avatarIds:a.avatarIds??[]}:{releaseId:i.id};t(`\u203A installing for tenant (${p}-scoped)`),d=await r("POST","/admin/runtime-plugins/installs",$),k(d,t)}return{packed:e,preview:l,catalog:g.catalog,release:i,install:d}}o(f,"publishPackedPlugin");function b(e){const a=[];return e.parts.frontend&&a.push(`frontend (${e.parts.frontend.locales.length} locales)`),e.parts.backend&&a.push(`backend (${e.parts.backend.migrationCount} migrations)`),e.parts.claw&&a.push("claw"),a.join(", ")||"no parts"}o(b,"describeParts");function k(e,a){const t=e.avatars;if(!t||t.attempted===0){a(`  installed ${e.pluginId}@${e.version}`);return}const n=t.attempted-t.failures.length;a(`  installed ${e.pluginId}@${e.version} \u2014 ${n}/${t.attempted} avatars`);for(const r of t.failures)a(`    \u2717 ${r.avatarId}: ${r.message}`)}o(k,"reportInstall");function A(e,a,t){const n=e.replace(/\/+$/,"");return o(async function(s,c,u){const l=await t(`${n}${I}${c}`,{method:s,headers:{authorization:`Bearer ${a}`,...u===void 0?{}:{"content-type":"application/json"}},...u===void 0?{}:{body:JSON.stringify(u)}});return m(l,`${s} ${c}`)},"call")}o(A,"createCaller");async function S(e,a,t,n){const r=e.replace(/\/+$/,""),s=await n(`${r}${a}`,{method:"PUT",headers:{"content-type":"application/zip"},body:t});await m(s,"PUT upload")}o(S,"putArchive");async function m(e,a){let t;try{t=await e.json()}catch{t=null}if(!e.ok||!t?.success){const n=t?.error?.message??`HTTP ${e.status}`;throw new Error(`${a} failed: ${n}`)}return t.data}o(m,"unwrap");export{f as publishPackedPlugin,T as publishPlugin};