@gorgo/medusa-integration 0.1.3 → 0.1.5

package/.medusa/server/src/types/http/integration/admin/entities.d.ts

@@ -47,9 +47,17 @@ export interface CatalogIntegration {
     label: string;
     shortDescription: string;
     repository: string;
-    docsUrl: string;
-    /** Config to paste into medusa-config (absent for some providers). */
-    configSnippet?: string;
+    /** Dropped at the catalog boundary unless it is an absolute https URL — see `isSafeHref`. */
+    docsUrl?: string;
+    /**
+     * Markdown setup guide shown in the Admin install drawer, per locale. Either locale may be
+     * absent: the catalog boundary keeps a locale only when it is a usable string, so a
+     * single-locale snippet is common, not malformed.
+     */
+    docsSnippet?: {
+        en?: string;
+        ru?: string;
+    };
     /** Icon URL (relative to the Gorgo host). */
     icon: string;
     stars: number | null;

package/.medusa/server/src/types/integration/common.d.ts

@@ -18,7 +18,7 @@ export interface UiField {
     label: I18nKey;
     hint?: I18nKey;
     placeholder?: string;
-    options?: string[];
+    options?: (string | number)[];
     /** For `select`: i18n-key label per enum value (value → key). UI shows the label, stores the value. */
     optionLabels?: Partial<Record<string, I18nKey>>;
     /** Descriptor default for a (non-secret) field — pre-fills the edit form when there's no stored value. */

package/README.md

@@ -1,6 +1,6 @@
 <p align="center">
-  <a href="https://docs.gorgojs.com/integrations/integration">
-    <img alt="Integration Module logo" src="https://raw.githubusercontent.com/gorgojs/medusa-integrations/refs/heads/main/assets/integration-medusa-logo.svg" width="100">
+  <a href="https://docs.gorgojs.com/medusa-modules/integration">
+    <img alt="Integration Module logo" src="https://raw.githubusercontent.com/gorgojs/medusa-integrations/refs/heads/main/assets/integration-medusa-logo.svg" width="270">
   </a>
 </p>
 
@@ -9,7 +9,7 @@ Integration Module for Medusa
 </h1>
 
 <p align="center">
-  <a href="https://docs.gorgojs.com/integrations/integration">Documentation</a>
+  <a href="https://docs.gorgojs.com/medusa-modules/integration">Documentation</a>
   <br/>
   A Medusa module that lets any plugin or provider declare its options and store admins manage them in the Admin – no <code>medusa-config</code> edits, no redeploys.
   <br/>
@@ -47,7 +47,7 @@ Integration Module for Medusa
 
 ## What is the Integration Module?
 
-The Integration Module lets any plugin declare its options, and store admins configure them as **integrations** right in the Admin – no `medusa-config` edits, no redeploys. It generates the admin CRUD API and validation, so there are no data models, routes, or forms to write.
+The Integration Module lets any plugin declare its options, and store admins configure them as **integrations** right in the Admin – no `medusa-config` edits, no redeploys. The module takes care of the UI, storage, encryption, and validation.
 
 The Integration Module is useful for any Medusa developer building plugins, providers, or custom modules that need configurable settings, such as API keys, credentials, modes, or webhooks, but who'd rather not hand-build settings UI pages, a data layer, and validation for each one.
 
@@ -75,7 +75,7 @@ The Integration Module is useful for any Medusa developer building plugins, prov
 
 <p>
   <a href="https://www.npmjs.com/package/@gorgo/medusa-payment-tkassa">
-    <img src="https://raw.githubusercontent.com/gorgojs/medusa-integrations/refs/heads/main/catalog/icons/tkassa.png" width="50" hspace="5" align="left" alt="T-Kassa logo"/>
+    <img src="https://raw.githubusercontent.com/gorgojs/medusa-integrations/refs/heads/main/catalog/icons/tkassa.svg" width="50" hspace="5" align="left" alt="T-Kassa logo"/>
   </a>
   <b>T-Kassa by T-Bank</b><br/>
   Payment · <a href="https://www.npmjs.com/package/@gorgo/medusa-payment-tkassa">@gorgo/medusa-payment-tkassa</a>

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@gorgo/medusa-integration",
-  "version": "0.1.3",
+  "version": "0.1.5",
   "description": "Integration module for Medusa",
   "author": {
     "name": "Gorgo",
@@ -44,8 +44,9 @@
   "scripts": {
     "build": "medusa plugin:build",
     "dev": "yarn predev && medusa plugin:develop",
+    "catalog:gen": "node scripts/gen-catalog.mjs",
     "predev": "medusa plugin:publish",
-    "prepublishOnly": "medusa plugin:build",
+    "prepublishOnly": "yarn catalog:gen && medusa plugin:build",
     "test:unit": "TEST_TYPE=unit NODE_OPTIONS=--experimental-vm-modules jest --silent --runInBand --forceExit"
   },
   "dependencies": {