@botpress/cli 0.9.6 → 0.11.0

package/dist/errors.js.map

@@ -1,7 +1,7 @@
 {
   "version": 3,
   "sources": ["../src/errors.ts"],
-  "sourcesContent": ["import { isApiError, ApiError, UnknownError } from '@botpress/client'\nimport axios, { AxiosError } from 'axios'\nimport { VError } from 'verror'\nimport * as consts from './consts'\n\ntype KnownApiError = Exclude<ApiError, UnknownError>\nconst isKnownApiError = (e: unknown): e is KnownApiError => isApiError(e) && !(e instanceof UnknownError)\n\nexport class BotpressCLIError extends VError {\n  public static wrap(thrown: unknown, message: string): BotpressCLIError {\n    const err = BotpressCLIError.map(thrown)\n    return new BotpressCLIError(err, message ?? '')\n  }\n\n  public static map(thrown: unknown): BotpressCLIError {\n    if (thrown instanceof BotpressCLIError) {\n      return thrown\n    }\n    if (thrown instanceof UnknownError) {\n      const inst = new HTTPError(500, 'An unknown error has occurred.')\n      inst.debug = thrown.message\n      return inst\n    }\n    if (isKnownApiError(thrown)) {\n      return HTTPError.fromApi(thrown)\n    }\n    if (axios.isAxiosError(thrown)) {\n      return HTTPError.fromAxios(thrown)\n    }\n    if (thrown instanceof Error) {\n      const { message } = thrown\n      return new BotpressCLIError(message)\n    }\n    return new BotpressCLIError(`${thrown}`)\n  }\n\n  private readonly _debug: string[]\n\n  constructor(error: BotpressCLIError, message: string)\n  constructor(message: string)\n  public constructor(first: BotpressCLIError | string, second?: string) {\n    if (typeof first === 'string') {\n      super(first)\n      this._debug = []\n      return\n    }\n    super(first, second!)\n    this._debug = [...first._debug]\n  }\n\n  public set debug(msg: string) {\n    this._debug.push(msg)\n  }\n\n  public get debug(): string {\n    const dbgMsgs = this._debug.filter((s) => s.length)\n    if (!dbgMsgs.length) {\n      return ''\n    }\n    return 'Error: \\n' + dbgMsgs.map((s) => `  ${s}`).join('\\n')\n  }\n}\n\nexport class ExclusiveBotFeatureError extends BotpressCLIError {\n  constructor() {\n    const message = 'This feature is only available for bots. This project is an integration or interface.'\n    super(message)\n  }\n}\n\nexport class ExclusiveIntegrationFeatureError extends BotpressCLIError {\n  constructor() {\n    const message = 'This feature is only available for integration. This project is a bot or interface.'\n    super(message)\n  }\n}\n\nexport class HTTPError extends BotpressCLIError {\n  constructor(public readonly status: number | undefined, message: string) {\n    super(message)\n  }\n\n  public static fromAxios(e: AxiosError<{ message?: string }>): HTTPError {\n    const message = this._axiosMsg(e)\n    return new HTTPError(e.response?.status, message)\n  }\n\n  public static fromApi(e: KnownApiError): HTTPError {\n    const { message, code } = e\n    return new HTTPError(code, message)\n  }\n\n  private static _axiosMsg(e: AxiosError<{ message?: string }>): string {\n    let message = e.message\n    if (e.response?.statusText) {\n      message += `\\n  ${e.response?.statusText}`\n    }\n    if (e.response?.status && e.request?.method && e.request?.path) {\n      message += `\\n  (${e.response?.status}) ${e.request.method} ${e.request.path}`\n    }\n    if (e.response?.data?.message) {\n      message += `\\n  ${e.response?.data?.message}`\n    }\n    return message\n  }\n}\n\nexport class NoBundleFoundError extends BotpressCLIError {\n  constructor() {\n    const message = 'No bundle found. Please run `bp bundle` first.'\n    super(message)\n  }\n}\n\nexport class NoBotsFoundError extends BotpressCLIError {\n  constructor() {\n    const message = `No Bot found in your Workspace. Please create one first at ${consts.defaultBotpressAppUrl}.`\n    super(message)\n  }\n}\n\nexport class NoWorkspacesFoundError extends BotpressCLIError {\n  constructor() {\n    const message = 'No Workspace found. Please create one first.'\n    super(message)\n  }\n}\n\nexport class NotLoggedInError extends BotpressCLIError {\n  constructor() {\n    const message = 'Not logged in. Please run `bp login` first.'\n    super(message)\n  }\n}\n\nexport class ParamRequiredError extends BotpressCLIError {\n  constructor(param: string) {\n    const message = `${param} is required.`\n    super(message)\n  }\n}\n\nexport class InvalidIntegrationReferenceError extends BotpressCLIError {\n  constructor(ref: string) {\n    const message = `Invalid integration reference \"${ref}\".`\n    super(message)\n  }\n}\n\nexport class InvalidInterfaceReferenceError extends BotpressCLIError {\n  constructor(ref: string) {\n    const message = `Invalid interface reference \"${ref}\".`\n    super(message)\n  }\n}\n"],
-  "mappings": ";;;;;;;;;;;;;;;;;;;;;;;;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,oBAAmD;AACnD,mBAAkC;AAClC,oBAAuB;AACvB,aAAwB;AAGxB,MAAM,kBAAkB,CAAC,UAAmC,0BAAW,CAAC,KAAK,EAAE,aAAa;AAErF,MAAM,yBAAyB,qBAAO;AAAA,EAC3C,OAAc,KAAK,QAAiB,SAAmC;AACrE,UAAM,MAAM,iBAAiB,IAAI,MAAM;AACvC,WAAO,IAAI,iBAAiB,KAAK,WAAW,EAAE;AAAA,EAChD;AAAA,EAEA,OAAc,IAAI,QAAmC;AACnD,QAAI,kBAAkB,kBAAkB;AACtC,aAAO;AAAA,IACT;AACA,QAAI,kBAAkB,4BAAc;AAClC,YAAM,OAAO,IAAI,UAAU,KAAK,gCAAgC;AAChE,WAAK,QAAQ,OAAO;AACpB,aAAO;AAAA,IACT;AACA,QAAI,gBAAgB,MAAM,GAAG;AAC3B,aAAO,UAAU,QAAQ,MAAM;AAAA,IACjC;AACA,QAAI,aAAAA,QAAM,aAAa,MAAM,GAAG;AAC9B,aAAO,UAAU,UAAU,MAAM;AAAA,IACnC;AACA,QAAI,kBAAkB,OAAO;AAC3B,YAAM,EAAE,QAAQ,IAAI;AACpB,aAAO,IAAI,iBAAiB,OAAO;AAAA,IACrC;AACA,WAAO,IAAI,iBAAiB,GAAG,QAAQ;AAAA,EACzC;AAAA,EAEiB;AAAA,EAIV,YAAY,OAAkC,QAAiB;AACpE,QAAI,OAAO,UAAU,UAAU;AAC7B,YAAM,KAAK;AACX,WAAK,SAAS,CAAC;AACf;AAAA,IACF;AACA,UAAM,OAAO,MAAO;AACpB,SAAK,SAAS,CAAC,GAAG,MAAM,MAAM;AAAA,EAChC;AAAA,EAEA,IAAW,MAAM,KAAa;AAC5B,SAAK,OAAO,KAAK,GAAG;AAAA,EACtB;AAAA,EAEA,IAAW,QAAgB;AACzB,UAAM,UAAU,KAAK,OAAO,OAAO,CAAC,MAAM,EAAE,MAAM;AAClD,QAAI,CAAC,QAAQ,QAAQ;AACnB,aAAO;AAAA,IACT;AACA,WAAO,cAAc,QAAQ,IAAI,CAAC,MAAM,KAAK,GAAG,EAAE,KAAK,IAAI;AAAA,EAC7D;AACF;AAEO,MAAM,iCAAiC,iBAAiB;AAAA,EAC7D,cAAc;AACZ,UAAM,UAAU;AAChB,UAAM,OAAO;AAAA,EACf;AACF;AAEO,MAAM,yCAAyC,iBAAiB;AAAA,EACrE,cAAc;AACZ,UAAM,UAAU;AAChB,UAAM,OAAO;AAAA,EACf;AACF;AAEO,MAAM,kBAAkB,iBAAiB;AAAA,EAC9C,YAA4B,QAA4B,SAAiB;AACvE,UAAM,OAAO;AADa;AAAA,EAE5B;AAAA,EAEA,OAAc,UAAU,GAAgD;AACtE,UAAM,UAAU,KAAK,UAAU,CAAC;AAChC,WAAO,IAAI,UAAU,EAAE,UAAU,QAAQ,OAAO;AAAA,EAClD;AAAA,EAEA,OAAc,QAAQ,GAA6B;AACjD,UAAM,EAAE,SAAS,KAAK,IAAI;AAC1B,WAAO,IAAI,UAAU,MAAM,OAAO;AAAA,EACpC;AAAA,EAEA,OAAe,UAAU,GAA6C;AACpE,QAAI,UAAU,EAAE;AAChB,QAAI,EAAE,UAAU,YAAY;AAC1B,iBAAW;AAAA,IAAO,EAAE,UAAU;AAAA,IAChC;AACA,QAAI,EAAE,UAAU,UAAU,EAAE,SAAS,UAAU,EAAE,SAAS,MAAM;AAC9D,iBAAW;AAAA,KAAQ,EAAE,UAAU,WAAW,EAAE,QAAQ,UAAU,EAAE,QAAQ;AAAA,IAC1E;AACA,QAAI,EAAE,UAAU,MAAM,SAAS;AAC7B,iBAAW;AAAA,IAAO,EAAE,UAAU,MAAM;AAAA,IACtC;AACA,WAAO;AAAA,EACT;AACF;AAEO,MAAM,2BAA2B,iBAAiB;AAAA,EACvD,cAAc;AACZ,UAAM,UAAU;AAChB,UAAM,OAAO;AAAA,EACf;AACF;AAEO,MAAM,yBAAyB,iBAAiB;AAAA,EACrD,cAAc;AACZ,UAAM,UAAU,8DAA8D,OAAO;AACrF,UAAM,OAAO;AAAA,EACf;AACF;AAEO,MAAM,+BAA+B,iBAAiB;AAAA,EAC3D,cAAc;AACZ,UAAM,UAAU;AAChB,UAAM,OAAO;AAAA,EACf;AACF;AAEO,MAAM,yBAAyB,iBAAiB;AAAA,EACrD,cAAc;AACZ,UAAM,UAAU;AAChB,UAAM,OAAO;AAAA,EACf;AACF;AAEO,MAAM,2BAA2B,iBAAiB;AAAA,EACvD,YAAY,OAAe;AACzB,UAAM,UAAU,GAAG;AACnB,UAAM,OAAO;AAAA,EACf;AACF;AAEO,MAAM,yCAAyC,iBAAiB;AAAA,EACrE,YAAY,KAAa;AACvB,UAAM,UAAU,kCAAkC;AAClD,UAAM,OAAO;AAAA,EACf;AACF;AAEO,MAAM,uCAAuC,iBAAiB;AAAA,EACnE,YAAY,KAAa;AACvB,UAAM,UAAU,gCAAgC;AAChD,UAAM,OAAO;AAAA,EACf;AACF;",
+  "sourcesContent": ["import { isApiError, ApiError, UnknownError } from '@botpress/client'\nimport axios, { AxiosError } from 'axios'\nimport { VError } from 'verror'\nimport * as consts from './consts'\n\ntype KnownApiError = Exclude<ApiError, UnknownError>\nconst isKnownApiError = (e: unknown): e is KnownApiError => isApiError(e) && !(e instanceof UnknownError)\n\nexport class BotpressCLIError extends VError {\n  public static wrap(thrown: unknown, message: string): BotpressCLIError {\n    const err = BotpressCLIError.map(thrown)\n    return new BotpressCLIError(err, message ?? '')\n  }\n\n  public static map(thrown: unknown): BotpressCLIError {\n    if (thrown instanceof BotpressCLIError) {\n      return thrown\n    }\n    if (thrown instanceof UnknownError) {\n      const inst = new HTTPError(500, 'An unknown error has occurred.')\n      inst.debug = thrown.message\n      return inst\n    }\n    if (isKnownApiError(thrown)) {\n      return HTTPError.fromApi(thrown)\n    }\n    if (axios.isAxiosError(thrown)) {\n      return HTTPError.fromAxios(thrown)\n    }\n    if (thrown instanceof Error) {\n      const { message } = thrown\n      return new BotpressCLIError(message)\n    }\n    return new BotpressCLIError(`${thrown}`)\n  }\n\n  private readonly _debug: string[]\n\n  public constructor(error: BotpressCLIError, message: string)\n  public constructor(message: string)\n  public constructor(first: BotpressCLIError | string, second?: string) {\n    if (typeof first === 'string') {\n      super(first)\n      this._debug = []\n      return\n    }\n    super(first, second!)\n    this._debug = [...first._debug]\n  }\n\n  public set debug(msg: string) {\n    this._debug.push(msg)\n  }\n\n  public get debug(): string {\n    const dbgMsgs = this._debug.filter((s) => s.length)\n    if (!dbgMsgs.length) {\n      return ''\n    }\n    return 'Error: \\n' + dbgMsgs.map((s) => `  ${s}`).join('\\n')\n  }\n}\n\nexport class ExclusiveBotFeatureError extends BotpressCLIError {\n  public constructor() {\n    const message = 'This feature is only available for bots. This project is an integration or interface.'\n    super(message)\n  }\n}\n\nexport class ExclusiveIntegrationFeatureError extends BotpressCLIError {\n  public constructor() {\n    const message = 'This feature is only available for integration. This project is a bot or interface.'\n    super(message)\n  }\n}\n\nexport class HTTPError extends BotpressCLIError {\n  public constructor(public readonly status: number | undefined, message: string) {\n    super(message)\n  }\n\n  public static fromAxios(e: AxiosError<{ message?: string }>): HTTPError {\n    const message = this._axiosMsg(e)\n    return new HTTPError(e.response?.status, message)\n  }\n\n  public static fromApi(e: KnownApiError): HTTPError {\n    const { message, code } = e\n    return new HTTPError(code, message)\n  }\n\n  private static _axiosMsg(e: AxiosError<{ message?: string }>): string {\n    let message = e.message\n    if (e.response?.statusText) {\n      message += `\\n  ${e.response?.statusText}`\n    }\n    if (e.response?.status && e.request?.method && e.request?.path) {\n      message += `\\n  (${e.response?.status}) ${e.request.method} ${e.request.path}`\n    }\n    if (e.response?.data?.message) {\n      message += `\\n  ${e.response?.data?.message}`\n    }\n    return message\n  }\n}\n\nexport class NoBundleFoundError extends BotpressCLIError {\n  public constructor() {\n    const message = 'No bundle found. Please run `bp bundle` first.'\n    super(message)\n  }\n}\n\nexport class NoBotsFoundError extends BotpressCLIError {\n  public constructor() {\n    const message = `No Bot found in your Workspace. Please create one first at ${consts.defaultBotpressAppUrl}.`\n    super(message)\n  }\n}\n\nexport class NoWorkspacesFoundError extends BotpressCLIError {\n  public constructor() {\n    const message = 'No Workspace found. Please create one first.'\n    super(message)\n  }\n}\n\nexport class NotLoggedInError extends BotpressCLIError {\n  public constructor() {\n    const message = 'Not logged in. Please run `bp login` first.'\n    super(message)\n  }\n}\n\nexport class ParamRequiredError extends BotpressCLIError {\n  public constructor(param: string) {\n    const message = `${param} is required.`\n    super(message)\n  }\n}\n\nexport class InvalidIntegrationReferenceError extends BotpressCLIError {\n  public constructor(ref: string) {\n    const message = `Invalid integration reference \"${ref}\".`\n    super(message)\n  }\n}\n\nexport class InvalidInterfaceReferenceError extends BotpressCLIError {\n  public constructor(ref: string) {\n    const message = `Invalid interface reference \"${ref}\".`\n    super(message)\n  }\n}\n"],
+  "mappings": ";;;;;;;;;;;;;;;;;;;;;;;;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,oBAAmD;AACnD,mBAAkC;AAClC,oBAAuB;AACvB,aAAwB;AAGxB,MAAM,kBAAkB,CAAC,UAAmC,0BAAW,CAAC,KAAK,EAAE,aAAa;AAErF,MAAM,yBAAyB,qBAAO;AAAA,EAC3C,OAAc,KAAK,QAAiB,SAAmC;AACrE,UAAM,MAAM,iBAAiB,IAAI,MAAM;AACvC,WAAO,IAAI,iBAAiB,KAAK,WAAW,EAAE;AAAA,EAChD;AAAA,EAEA,OAAc,IAAI,QAAmC;AACnD,QAAI,kBAAkB,kBAAkB;AACtC,aAAO;AAAA,IACT;AACA,QAAI,kBAAkB,4BAAc;AAClC,YAAM,OAAO,IAAI,UAAU,KAAK,gCAAgC;AAChE,WAAK,QAAQ,OAAO;AACpB,aAAO;AAAA,IACT;AACA,QAAI,gBAAgB,MAAM,GAAG;AAC3B,aAAO,UAAU,QAAQ,MAAM;AAAA,IACjC;AACA,QAAI,aAAAA,QAAM,aAAa,MAAM,GAAG;AAC9B,aAAO,UAAU,UAAU,MAAM;AAAA,IACnC;AACA,QAAI,kBAAkB,OAAO;AAC3B,YAAM,EAAE,QAAQ,IAAI;AACpB,aAAO,IAAI,iBAAiB,OAAO;AAAA,IACrC;AACA,WAAO,IAAI,iBAAiB,GAAG,QAAQ;AAAA,EACzC;AAAA,EAEiB;AAAA,EAIV,YAAY,OAAkC,QAAiB;AACpE,QAAI,OAAO,UAAU,UAAU;AAC7B,YAAM,KAAK;AACX,WAAK,SAAS,CAAC;AACf;AAAA,IACF;AACA,UAAM,OAAO,MAAO;AACpB,SAAK,SAAS,CAAC,GAAG,MAAM,MAAM;AAAA,EAChC;AAAA,EAEA,IAAW,MAAM,KAAa;AAC5B,SAAK,OAAO,KAAK,GAAG;AAAA,EACtB;AAAA,EAEA,IAAW,QAAgB;AACzB,UAAM,UAAU,KAAK,OAAO,OAAO,CAAC,MAAM,EAAE,MAAM;AAClD,QAAI,CAAC,QAAQ,QAAQ;AACnB,aAAO;AAAA,IACT;AACA,WAAO,cAAc,QAAQ,IAAI,CAAC,MAAM,KAAK,GAAG,EAAE,KAAK,IAAI;AAAA,EAC7D;AACF;AAEO,MAAM,iCAAiC,iBAAiB;AAAA,EACtD,cAAc;AACnB,UAAM,UAAU;AAChB,UAAM,OAAO;AAAA,EACf;AACF;AAEO,MAAM,yCAAyC,iBAAiB;AAAA,EAC9D,cAAc;AACnB,UAAM,UAAU;AAChB,UAAM,OAAO;AAAA,EACf;AACF;AAEO,MAAM,kBAAkB,iBAAiB;AAAA,EACvC,YAA4B,QAA4B,SAAiB;AAC9E,UAAM,OAAO;AADoB;AAAA,EAEnC;AAAA,EAEA,OAAc,UAAU,GAAgD;AACtE,UAAM,UAAU,KAAK,UAAU,CAAC;AAChC,WAAO,IAAI,UAAU,EAAE,UAAU,QAAQ,OAAO;AAAA,EAClD;AAAA,EAEA,OAAc,QAAQ,GAA6B;AACjD,UAAM,EAAE,SAAS,KAAK,IAAI;AAC1B,WAAO,IAAI,UAAU,MAAM,OAAO;AAAA,EACpC;AAAA,EAEA,OAAe,UAAU,GAA6C;AACpE,QAAI,UAAU,EAAE;AAChB,QAAI,EAAE,UAAU,YAAY;AAC1B,iBAAW;AAAA,IAAO,EAAE,UAAU;AAAA,IAChC;AACA,QAAI,EAAE,UAAU,UAAU,EAAE,SAAS,UAAU,EAAE,SAAS,MAAM;AAC9D,iBAAW;AAAA,KAAQ,EAAE,UAAU,WAAW,EAAE,QAAQ,UAAU,EAAE,QAAQ;AAAA,IAC1E;AACA,QAAI,EAAE,UAAU,MAAM,SAAS;AAC7B,iBAAW;AAAA,IAAO,EAAE,UAAU,MAAM;AAAA,IACtC;AACA,WAAO;AAAA,EACT;AACF;AAEO,MAAM,2BAA2B,iBAAiB;AAAA,EAChD,cAAc;AACnB,UAAM,UAAU;AAChB,UAAM,OAAO;AAAA,EACf;AACF;AAEO,MAAM,yBAAyB,iBAAiB;AAAA,EAC9C,cAAc;AACnB,UAAM,UAAU,8DAA8D,OAAO;AACrF,UAAM,OAAO;AAAA,EACf;AACF;AAEO,MAAM,+BAA+B,iBAAiB;AAAA,EACpD,cAAc;AACnB,UAAM,UAAU;AAChB,UAAM,OAAO;AAAA,EACf;AACF;AAEO,MAAM,yBAAyB,iBAAiB;AAAA,EAC9C,cAAc;AACnB,UAAM,UAAU;AAChB,UAAM,OAAO;AAAA,EACf;AACF;AAEO,MAAM,2BAA2B,iBAAiB;AAAA,EAChD,YAAY,OAAe;AAChC,UAAM,UAAU,GAAG;AACnB,UAAM,OAAO;AAAA,EACf;AACF;AAEO,MAAM,yCAAyC,iBAAiB;AAAA,EAC9D,YAAY,KAAa;AAC9B,UAAM,UAAU,kCAAkC;AAClD,UAAM,OAAO;AAAA,EACf;AACF;AAEO,MAAM,uCAAuC,iBAAiB;AAAA,EAC5D,YAAY,KAAa;AAC9B,UAAM,UAAU,gCAAgC;AAChD,UAAM,OAAO;AAAA,EACf;AACF;",
   "names": ["axios"]
 }

package/dist/integration-ref.test.js

@@ -1,12 +1,11 @@
 "use strict";
-var import_node_test = require("node:test");
 var import_vitest = require("vitest");
 var import_integration_ref = require("./integration-ref");
 const path = "/my/path";
 const prefixedUlid = "intver_01HF58RDKE3M7K5RJ5XZ7GF6HE";
 const uuid = "a0eebc99-9c0b-4ef8-bb6d-6bb9bd380a11";
 const name = "myintegration";
-(0, import_node_test.describe)("parseIntegrationRef", () => {
+(0, import_vitest.describe)("parseIntegrationRef", () => {
   (0, import_vitest.test)("parse empty string should return undefined", () => {
     const ref = "";
     const result = (0, import_integration_ref.parseIntegrationRef)(ref);
@@ -62,7 +61,7 @@ const name = "myintegration";
     (0, import_vitest.expect)(result).toEqual(expected);
   });
 });
-(0, import_node_test.describe)("formatIntegrationRef", () => {
+(0, import_vitest.describe)("formatIntegrationRef", () => {
   (0, import_vitest.test)("format with a path should return path", () => {
     const ref = { type: "path", path };
     const result = (0, import_integration_ref.formatIntegrationRef)(ref);

package/dist/integration-ref.test.js.map

@@ -1,7 +1,7 @@
 {
   "version": 3,
   "sources": ["../src/integration-ref.test.ts"],
-  "sourcesContent": ["import { describe } from 'node:test'\nimport { test, expect } from 'vitest'\nimport { formatIntegrationRef, IntegrationRef, parseIntegrationRef } from './integration-ref'\n\nconst path = '/my/path'\nconst prefixedUlid = 'intver_01HF58RDKE3M7K5RJ5XZ7GF6HE'\nconst uuid = 'a0eebc99-9c0b-4ef8-bb6d-6bb9bd380a11'\nconst name = 'myintegration'\n\ndescribe('parseIntegrationRef', () => {\n  test('parse empty string should return undefined', () => {\n    // arrange\n    const ref = ''\n    // act\n    const result = parseIntegrationRef(ref)\n    // assert\n    expect(result).toBeUndefined()\n  })\n\n  test('parse with invalid version should return undefined', () => {\n    // arrange\n    const ref0 = `${name}@lol`\n    const ref1 = `${name}@1`\n    const ref2 = `${name}@1.0`\n    // act\n    const result0 = parseIntegrationRef(ref0)\n    const result1 = parseIntegrationRef(ref1)\n    const result2 = parseIntegrationRef(ref2)\n    // assert\n    expect(result0).toBeUndefined()\n    expect(result1).toBeUndefined()\n    expect(result2).toBeUndefined()\n  })\n\n  test('parse with an absolute path should return path', () => {\n    // arrange\n    const ref = path\n    // act\n    const result = parseIntegrationRef(ref)\n    // assert\n    const expected: IntegrationRef = { type: 'path', path: ref }\n    expect(result).toEqual(expected)\n  })\n\n  test('parse with a prefixed ULID sets `id` type', () => {\n    // arrange\n    const ref = prefixedUlid\n    // act\n    const result = parseIntegrationRef(ref)\n    // assert\n    const expected: IntegrationRef = { type: 'id', id: ref }\n    expect(result).toEqual(expected)\n  })\n\n  test('parse with a legacy UUID sets `id` type', () => {\n    // arrange\n    const ref = uuid\n    // act\n    const result = parseIntegrationRef(ref)\n    // assert\n    const expected: IntegrationRef = { type: 'id', id: ref }\n    expect(result).toEqual(expected)\n  })\n\n  test('parse with a name and version should return name and version', () => {\n    // arrange\n    const version = '1.0.0'\n    const ref = `${name}@${version}`\n    // act\n    const result = parseIntegrationRef(ref)\n    // assert\n    const expected: IntegrationRef = { type: 'name', name, version }\n    expect(result).toEqual(expected)\n  })\n\n  test('parse with a name and latest should return name and latest', () => {\n    // arrange\n    const version = 'latest'\n    const ref = `${name}@${version}`\n    // act\n    const result = parseIntegrationRef(ref)\n    // assert\n    const expected: IntegrationRef = { type: 'name', name, version }\n    expect(result).toEqual(expected)\n  })\n\n  test('parse with only a name should return name and latest', () => {\n    // arrange\n    const ref = name\n    // act\n    const result = parseIntegrationRef(ref)\n    // assert\n    const expected: IntegrationRef = { type: 'name', name, version: 'latest' }\n    expect(result).toEqual(expected)\n  })\n})\n\ndescribe('formatIntegrationRef', () => {\n  test('format with a path should return path', () => {\n    // arrange\n    const ref: IntegrationRef = { type: 'path', path }\n    // act\n    const result = formatIntegrationRef(ref)\n    // assert\n    expect(result).toEqual(ref.path)\n  })\n\n  test('format with a prefixed ULID uses `id` type', () => {\n    // arrange\n    const ref: IntegrationRef = { type: 'id', id: prefixedUlid }\n    // act\n    const result = formatIntegrationRef(ref)\n    // assert\n    expect(result).toEqual(ref.id)\n  })\n\n  test('format with a legacy UUID uses `id` type', () => {\n    // arrange\n    const ref: IntegrationRef = { type: 'id', id: uuid }\n    // act\n    const result = formatIntegrationRef(ref)\n    // assert\n    expect(result).toEqual(ref.id)\n  })\n\n  test('format with a name and version should return name and version', () => {\n    // arrange\n    const version = '1.0.0'\n    const ref: IntegrationRef = { type: 'name', name, version }\n    // act\n    const result = formatIntegrationRef(ref)\n    // assert\n    expect(result).toEqual(`${name}@${version}`)\n  })\n})\n"],
-  "mappings": ";AAAA,uBAAyB;AACzB,oBAA6B;AAC7B,6BAA0E;AAE1E,MAAM,OAAO;AACb,MAAM,eAAe;AACrB,MAAM,OAAO;AACb,MAAM,OAAO;AAAA,IAEb,2BAAS,uBAAuB,MAAM;AACpC,0BAAK,8CAA8C,MAAM;AAEvD,UAAM,MAAM;AAEZ,UAAM,aAAS,4CAAoB,GAAG;AAEtC,8BAAO,MAAM,EAAE,cAAc;AAAA,EAC/B,CAAC;AAED,0BAAK,sDAAsD,MAAM;AAE/D,UAAM,OAAO,GAAG;AAChB,UAAM,OAAO,GAAG;AAChB,UAAM,OAAO,GAAG;AAEhB,UAAM,cAAU,4CAAoB,IAAI;AACxC,UAAM,cAAU,4CAAoB,IAAI;AACxC,UAAM,cAAU,4CAAoB,IAAI;AAExC,8BAAO,OAAO,EAAE,cAAc;AAC9B,8BAAO,OAAO,EAAE,cAAc;AAC9B,8BAAO,OAAO,EAAE,cAAc;AAAA,EAChC,CAAC;AAED,0BAAK,kDAAkD,MAAM;AAE3D,UAAM,MAAM;AAEZ,UAAM,aAAS,4CAAoB,GAAG;AAEtC,UAAM,WAA2B,EAAE,MAAM,QAAQ,MAAM,IAAI;AAC3D,8BAAO,MAAM,EAAE,QAAQ,QAAQ;AAAA,EACjC,CAAC;AAED,0BAAK,6CAA6C,MAAM;AAEtD,UAAM,MAAM;AAEZ,UAAM,aAAS,4CAAoB,GAAG;AAEtC,UAAM,WAA2B,EAAE,MAAM,MAAM,IAAI,IAAI;AACvD,8BAAO,MAAM,EAAE,QAAQ,QAAQ;AAAA,EACjC,CAAC;AAED,0BAAK,2CAA2C,MAAM;AAEpD,UAAM,MAAM;AAEZ,UAAM,aAAS,4CAAoB,GAAG;AAEtC,UAAM,WAA2B,EAAE,MAAM,MAAM,IAAI,IAAI;AACvD,8BAAO,MAAM,EAAE,QAAQ,QAAQ;AAAA,EACjC,CAAC;AAED,0BAAK,gEAAgE,MAAM;AAEzE,UAAM,UAAU;AAChB,UAAM,MAAM,GAAG,QAAQ;AAEvB,UAAM,aAAS,4CAAoB,GAAG;AAEtC,UAAM,WAA2B,EAAE,MAAM,QAAQ,MAAM,QAAQ;AAC/D,8BAAO,MAAM,EAAE,QAAQ,QAAQ;AAAA,EACjC,CAAC;AAED,0BAAK,8DAA8D,MAAM;AAEvE,UAAM,UAAU;AAChB,UAAM,MAAM,GAAG,QAAQ;AAEvB,UAAM,aAAS,4CAAoB,GAAG;AAEtC,UAAM,WAA2B,EAAE,MAAM,QAAQ,MAAM,QAAQ;AAC/D,8BAAO,MAAM,EAAE,QAAQ,QAAQ;AAAA,EACjC,CAAC;AAED,0BAAK,wDAAwD,MAAM;AAEjE,UAAM,MAAM;AAEZ,UAAM,aAAS,4CAAoB,GAAG;AAEtC,UAAM,WAA2B,EAAE,MAAM,QAAQ,MAAM,SAAS,SAAS;AACzE,8BAAO,MAAM,EAAE,QAAQ,QAAQ;AAAA,EACjC,CAAC;AACH,CAAC;AAAA,IAED,2BAAS,wBAAwB,MAAM;AACrC,0BAAK,yCAAyC,MAAM;AAElD,UAAM,MAAsB,EAAE,MAAM,QAAQ,KAAK;AAEjD,UAAM,aAAS,6CAAqB,GAAG;AAEvC,8BAAO,MAAM,EAAE,QAAQ,IAAI,IAAI;AAAA,EACjC,CAAC;AAED,0BAAK,8CAA8C,MAAM;AAEvD,UAAM,MAAsB,EAAE,MAAM,MAAM,IAAI,aAAa;AAE3D,UAAM,aAAS,6CAAqB,GAAG;AAEvC,8BAAO,MAAM,EAAE,QAAQ,IAAI,EAAE;AAAA,EAC/B,CAAC;AAED,0BAAK,4CAA4C,MAAM;AAErD,UAAM,MAAsB,EAAE,MAAM,MAAM,IAAI,KAAK;AAEnD,UAAM,aAAS,6CAAqB,GAAG;AAEvC,8BAAO,MAAM,EAAE,QAAQ,IAAI,EAAE;AAAA,EAC/B,CAAC;AAED,0BAAK,iEAAiE,MAAM;AAE1E,UAAM,UAAU;AAChB,UAAM,MAAsB,EAAE,MAAM,QAAQ,MAAM,QAAQ;AAE1D,UAAM,aAAS,6CAAqB,GAAG;AAEvC,8BAAO,MAAM,EAAE,QAAQ,GAAG,QAAQ,SAAS;AAAA,EAC7C,CAAC;AACH,CAAC;",
+  "sourcesContent": ["import { test, expect, describe } from 'vitest'\nimport { formatIntegrationRef, IntegrationRef, parseIntegrationRef } from './integration-ref'\n\nconst path = '/my/path'\nconst prefixedUlid = 'intver_01HF58RDKE3M7K5RJ5XZ7GF6HE'\nconst uuid = 'a0eebc99-9c0b-4ef8-bb6d-6bb9bd380a11'\nconst name = 'myintegration'\n\ndescribe('parseIntegrationRef', () => {\n  test('parse empty string should return undefined', () => {\n    // arrange\n    const ref = ''\n    // act\n    const result = parseIntegrationRef(ref)\n    // assert\n    expect(result).toBeUndefined()\n  })\n\n  test('parse with invalid version should return undefined', () => {\n    // arrange\n    const ref0 = `${name}@lol`\n    const ref1 = `${name}@1`\n    const ref2 = `${name}@1.0`\n    // act\n    const result0 = parseIntegrationRef(ref0)\n    const result1 = parseIntegrationRef(ref1)\n    const result2 = parseIntegrationRef(ref2)\n    // assert\n    expect(result0).toBeUndefined()\n    expect(result1).toBeUndefined()\n    expect(result2).toBeUndefined()\n  })\n\n  test('parse with an absolute path should return path', () => {\n    // arrange\n    const ref = path\n    // act\n    const result = parseIntegrationRef(ref)\n    // assert\n    const expected: IntegrationRef = { type: 'path', path: ref }\n    expect(result).toEqual(expected)\n  })\n\n  test('parse with a prefixed ULID sets `id` type', () => {\n    // arrange\n    const ref = prefixedUlid\n    // act\n    const result = parseIntegrationRef(ref)\n    // assert\n    const expected: IntegrationRef = { type: 'id', id: ref }\n    expect(result).toEqual(expected)\n  })\n\n  test('parse with a legacy UUID sets `id` type', () => {\n    // arrange\n    const ref = uuid\n    // act\n    const result = parseIntegrationRef(ref)\n    // assert\n    const expected: IntegrationRef = { type: 'id', id: ref }\n    expect(result).toEqual(expected)\n  })\n\n  test('parse with a name and version should return name and version', () => {\n    // arrange\n    const version = '1.0.0'\n    const ref = `${name}@${version}`\n    // act\n    const result = parseIntegrationRef(ref)\n    // assert\n    const expected: IntegrationRef = { type: 'name', name, version }\n    expect(result).toEqual(expected)\n  })\n\n  test('parse with a name and latest should return name and latest', () => {\n    // arrange\n    const version = 'latest'\n    const ref = `${name}@${version}`\n    // act\n    const result = parseIntegrationRef(ref)\n    // assert\n    const expected: IntegrationRef = { type: 'name', name, version }\n    expect(result).toEqual(expected)\n  })\n\n  test('parse with only a name should return name and latest', () => {\n    // arrange\n    const ref = name\n    // act\n    const result = parseIntegrationRef(ref)\n    // assert\n    const expected: IntegrationRef = { type: 'name', name, version: 'latest' }\n    expect(result).toEqual(expected)\n  })\n})\n\ndescribe('formatIntegrationRef', () => {\n  test('format with a path should return path', () => {\n    // arrange\n    const ref: IntegrationRef = { type: 'path', path }\n    // act\n    const result = formatIntegrationRef(ref)\n    // assert\n    expect(result).toEqual(ref.path)\n  })\n\n  test('format with a prefixed ULID uses `id` type', () => {\n    // arrange\n    const ref: IntegrationRef = { type: 'id', id: prefixedUlid }\n    // act\n    const result = formatIntegrationRef(ref)\n    // assert\n    expect(result).toEqual(ref.id)\n  })\n\n  test('format with a legacy UUID uses `id` type', () => {\n    // arrange\n    const ref: IntegrationRef = { type: 'id', id: uuid }\n    // act\n    const result = formatIntegrationRef(ref)\n    // assert\n    expect(result).toEqual(ref.id)\n  })\n\n  test('format with a name and version should return name and version', () => {\n    // arrange\n    const version = '1.0.0'\n    const ref: IntegrationRef = { type: 'name', name, version }\n    // act\n    const result = formatIntegrationRef(ref)\n    // assert\n    expect(result).toEqual(`${name}@${version}`)\n  })\n})\n"],
+  "mappings": ";AAAA,oBAAuC;AACvC,6BAA0E;AAE1E,MAAM,OAAO;AACb,MAAM,eAAe;AACrB,MAAM,OAAO;AACb,MAAM,OAAO;AAAA,IAEb,wBAAS,uBAAuB,MAAM;AACpC,0BAAK,8CAA8C,MAAM;AAEvD,UAAM,MAAM;AAEZ,UAAM,aAAS,4CAAoB,GAAG;AAEtC,8BAAO,MAAM,EAAE,cAAc;AAAA,EAC/B,CAAC;AAED,0BAAK,sDAAsD,MAAM;AAE/D,UAAM,OAAO,GAAG;AAChB,UAAM,OAAO,GAAG;AAChB,UAAM,OAAO,GAAG;AAEhB,UAAM,cAAU,4CAAoB,IAAI;AACxC,UAAM,cAAU,4CAAoB,IAAI;AACxC,UAAM,cAAU,4CAAoB,IAAI;AAExC,8BAAO,OAAO,EAAE,cAAc;AAC9B,8BAAO,OAAO,EAAE,cAAc;AAC9B,8BAAO,OAAO,EAAE,cAAc;AAAA,EAChC,CAAC;AAED,0BAAK,kDAAkD,MAAM;AAE3D,UAAM,MAAM;AAEZ,UAAM,aAAS,4CAAoB,GAAG;AAEtC,UAAM,WAA2B,EAAE,MAAM,QAAQ,MAAM,IAAI;AAC3D,8BAAO,MAAM,EAAE,QAAQ,QAAQ;AAAA,EACjC,CAAC;AAED,0BAAK,6CAA6C,MAAM;AAEtD,UAAM,MAAM;AAEZ,UAAM,aAAS,4CAAoB,GAAG;AAEtC,UAAM,WAA2B,EAAE,MAAM,MAAM,IAAI,IAAI;AACvD,8BAAO,MAAM,EAAE,QAAQ,QAAQ;AAAA,EACjC,CAAC;AAED,0BAAK,2CAA2C,MAAM;AAEpD,UAAM,MAAM;AAEZ,UAAM,aAAS,4CAAoB,GAAG;AAEtC,UAAM,WAA2B,EAAE,MAAM,MAAM,IAAI,IAAI;AACvD,8BAAO,MAAM,EAAE,QAAQ,QAAQ;AAAA,EACjC,CAAC;AAED,0BAAK,gEAAgE,MAAM;AAEzE,UAAM,UAAU;AAChB,UAAM,MAAM,GAAG,QAAQ;AAEvB,UAAM,aAAS,4CAAoB,GAAG;AAEtC,UAAM,WAA2B,EAAE,MAAM,QAAQ,MAAM,QAAQ;AAC/D,8BAAO,MAAM,EAAE,QAAQ,QAAQ;AAAA,EACjC,CAAC;AAED,0BAAK,8DAA8D,MAAM;AAEvE,UAAM,UAAU;AAChB,UAAM,MAAM,GAAG,QAAQ;AAEvB,UAAM,aAAS,4CAAoB,GAAG;AAEtC,UAAM,WAA2B,EAAE,MAAM,QAAQ,MAAM,QAAQ;AAC/D,8BAAO,MAAM,EAAE,QAAQ,QAAQ;AAAA,EACjC,CAAC;AAED,0BAAK,wDAAwD,MAAM;AAEjE,UAAM,MAAM;AAEZ,UAAM,aAAS,4CAAoB,GAAG;AAEtC,UAAM,WAA2B,EAAE,MAAM,QAAQ,MAAM,SAAS,SAAS;AACzE,8BAAO,MAAM,EAAE,QAAQ,QAAQ;AAAA,EACjC,CAAC;AACH,CAAC;AAAA,IAED,wBAAS,wBAAwB,MAAM;AACrC,0BAAK,yCAAyC,MAAM;AAElD,UAAM,MAAsB,EAAE,MAAM,QAAQ,KAAK;AAEjD,UAAM,aAAS,6CAAqB,GAAG;AAEvC,8BAAO,MAAM,EAAE,QAAQ,IAAI,IAAI;AAAA,EACjC,CAAC;AAED,0BAAK,8CAA8C,MAAM;AAEvD,UAAM,MAAsB,EAAE,MAAM,MAAM,IAAI,aAAa;AAE3D,UAAM,aAAS,6CAAqB,GAAG;AAEvC,8BAAO,MAAM,EAAE,QAAQ,IAAI,EAAE;AAAA,EAC/B,CAAC;AAED,0BAAK,4CAA4C,MAAM;AAErD,UAAM,MAAsB,EAAE,MAAM,MAAM,IAAI,KAAK;AAEnD,UAAM,aAAS,6CAAqB,GAAG;AAEvC,8BAAO,MAAM,EAAE,QAAQ,IAAI,EAAE;AAAA,EAC/B,CAAC;AAED,0BAAK,iEAAiE,MAAM;AAE1E,UAAM,UAAU;AAChB,UAAM,MAAsB,EAAE,MAAM,QAAQ,MAAM,QAAQ;AAE1D,UAAM,aAAS,6CAAqB,GAAG;AAEvC,8BAAO,MAAM,EAAE,QAAQ,GAAG,QAAQ,SAAS;AAAA,EAC7C,CAAC;AACH,CAAC;",
   "names": []
 }

package/dist/linter/integration-linter.js

@@ -0,0 +1,73 @@
+"use strict";
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __export = (target, all) => {
+  for (var name in all)
+    __defProp(target, name, { get: all[name], enumerable: true });
+};
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+var integration_linter_exports = {};
+__export(integration_linter_exports, {
+  IntegrationLinter: () => IntegrationLinter
+});
+module.exports = __toCommonJS(integration_linter_exports);
+var import_spectral_core = require("@stoplight/spectral-core");
+var import_spectral_parsers = require("@stoplight/spectral-parsers");
+var import_integration = require("./rulesets/integration.ruleset");
+class IntegrationLinter {
+  _spectral;
+  _spectralDocument;
+  _results = [];
+  constructor(definition) {
+    const json = JSON.stringify(definition).replaceAll('"$ref":', '"_$ref":');
+    this._spectralDocument = new import_spectral_core.Document(json, import_spectral_parsers.Json);
+    this._spectral = new import_spectral_core.Spectral();
+    this._spectral.setRuleset(import_integration.INTEGRATION_RULESET);
+  }
+  async lint() {
+    this._results = await this._spectral.run(this._spectralDocument);
+  }
+  logResults(logger) {
+    for (const result of this.getSortedResults()) {
+      const message = `${result.path}: ${result.message}`;
+      this._logResultMessage(logger, message, result.severity);
+    }
+  }
+  getSortedResults() {
+    return this._getResults().sort((a, b) => a.path > b.path ? 1 : a.path < b.path ? -1 : 0);
+  }
+  _getResults() {
+    return this._results.map((result) => ({
+      message: result.message,
+      path: this._simplifyPath(result.path),
+      severity: result.severity
+    }));
+  }
+  _simplifyPath(path) {
+    return path.join(".").replaceAll(".properties.", ".").replaceAll(".x-zui", "");
+  }
+  _logResultMessage(logger, message, severity) {
+    const logLevelMapping = {
+      0: logger.error,
+      1: logger.warn,
+      2: logger.log,
+      3: logger.debug
+    };
+    logLevelMapping[severity].call(logger, message);
+  }
+}
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  IntegrationLinter
+});
+//# sourceMappingURL=integration-linter.js.map

package/dist/linter/integration-linter.js.map

@@ -0,0 +1,7 @@
+{
+  "version": 3,
+  "sources": ["../../src/linter/integration-linter.ts"],
+  "sourcesContent": ["import { Spectral, Document, ISpectralDiagnostic } from '@stoplight/spectral-core'\nimport { Json as JsonParser, JsonParserResult } from '@stoplight/spectral-parsers'\nimport { CreateIntegrationBody } from '../api/integration-body'\nimport { Logger } from '../logger'\nimport { INTEGRATION_RULESET } from './rulesets/integration.ruleset'\n\ntype ProblemSeverity = 0 | 1 | 2 | 3\n\nexport class IntegrationLinter {\n  private readonly _spectral: Spectral\n  private readonly _spectralDocument: Document<unknown, JsonParserResult<unknown>>\n  private _results: ISpectralDiagnostic[] = []\n\n  public constructor(definition: CreateIntegrationBody) {\n    const json = JSON.stringify(definition).replaceAll('\"$ref\":', '\"_$ref\":')\n    this._spectralDocument = new Document(json, JsonParser)\n    this._spectral = new Spectral()\n\n    this._spectral.setRuleset(INTEGRATION_RULESET)\n  }\n\n  public async lint(): Promise<void> {\n    this._results = await this._spectral.run(this._spectralDocument)\n  }\n\n  public logResults(logger: Logger) {\n    for (const result of this.getSortedResults()) {\n      const message = `${result.path}: ${result.message}`\n\n      this._logResultMessage(logger, message, result.severity)\n    }\n  }\n\n  public getSortedResults() {\n    return this._getResults().sort((a, b) => (a.path > b.path ? 1 : a.path < b.path ? -1 : 0))\n  }\n\n  private _getResults() {\n    return this._results.map((result) => ({\n      message: result.message,\n      path: this._simplifyPath(result.path),\n      severity: result.severity as ProblemSeverity,\n    }))\n  }\n\n  private _simplifyPath(path: (string | number)[]) {\n    return path.join('.').replaceAll('.properties.', '.').replaceAll('.x-zui', '')\n  }\n\n  private _logResultMessage(logger: Logger, message: string, severity: ProblemSeverity) {\n    const logLevelMapping = {\n      0: logger.error,\n      1: logger.warn,\n      2: logger.log,\n      3: logger.debug,\n    } as const\n\n    logLevelMapping[severity].call(logger, message)\n  }\n}\n"],
+  "mappings": ";;;;;;;;;;;;;;;;;;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,2BAAwD;AACxD,8BAAqD;AAGrD,yBAAoC;AAI7B,MAAM,kBAAkB;AAAA,EACZ;AAAA,EACA;AAAA,EACT,WAAkC,CAAC;AAAA,EAEpC,YAAY,YAAmC;AACpD,UAAM,OAAO,KAAK,UAAU,UAAU,EAAE,WAAW,WAAW,UAAU;AACxE,SAAK,oBAAoB,IAAI,8BAAS,MAAM,wBAAAA,IAAU;AACtD,SAAK,YAAY,IAAI,8BAAS;AAE9B,SAAK,UAAU,WAAW,sCAAmB;AAAA,EAC/C;AAAA,EAEA,MAAa,OAAsB;AACjC,SAAK,WAAW,MAAM,KAAK,UAAU,IAAI,KAAK,iBAAiB;AAAA,EACjE;AAAA,EAEO,WAAW,QAAgB;AAChC,eAAW,UAAU,KAAK,iBAAiB,GAAG;AAC5C,YAAM,UAAU,GAAG,OAAO,SAAS,OAAO;AAE1C,WAAK,kBAAkB,QAAQ,SAAS,OAAO,QAAQ;AAAA,IACzD;AAAA,EACF;AAAA,EAEO,mBAAmB;AACxB,WAAO,KAAK,YAAY,EAAE,KAAK,CAAC,GAAG,MAAO,EAAE,OAAO,EAAE,OAAO,IAAI,EAAE,OAAO,EAAE,OAAO,KAAK,CAAE;AAAA,EAC3F;AAAA,EAEQ,cAAc;AACpB,WAAO,KAAK,SAAS,IAAI,CAAC,YAAY;AAAA,MACpC,SAAS,OAAO;AAAA,MAChB,MAAM,KAAK,cAAc,OAAO,IAAI;AAAA,MACpC,UAAU,OAAO;AAAA,IACnB,EAAE;AAAA,EACJ;AAAA,EAEQ,cAAc,MAA2B;AAC/C,WAAO,KAAK,KAAK,GAAG,EAAE,WAAW,gBAAgB,GAAG,EAAE,WAAW,UAAU,EAAE;AAAA,EAC/E;AAAA,EAEQ,kBAAkB,QAAgB,SAAiB,UAA2B;AACpF,UAAM,kBAAkB;AAAA,MACtB,GAAG,OAAO;AAAA,MACV,GAAG,OAAO;AAAA,MACV,GAAG,OAAO;AAAA,MACV,GAAG,OAAO;AAAA,IACZ;AAEA,oBAAgB,UAAU,KAAK,QAAQ,OAAO;AAAA,EAChD;AACF;",
+  "names": ["JsonParser"]
+}

package/dist/linter/integration-linter.test.js

@@ -0,0 +1,180 @@
+"use strict";
+var import_vitest = require("vitest");
+var import_integration_body = require("../api/integration-body");
+var import_integration_linter = require("./integration-linter");
+var import_sdk = require("@botpress/sdk");
+const EMPTY_STRING = "";
+const TRUTHY_STRING = "truthy";
+const ACTION_NAME = "actionName";
+const EVENT_NAME = "eventName";
+const CONFIG_NAME = "configName";
+const PARAM_NAME = "paramName";
+const TAG_NAME = "tagName";
+const CHANNEL_NAME = "channelName";
+const STATE_NAME = "stateName";
+const MESSAGE_TYPE = "text";
+const VALID_INTEGRATION = {
+  name: TRUTHY_STRING,
+  title: TRUTHY_STRING,
+  description: TRUTHY_STRING,
+  version: TRUTHY_STRING,
+  readme: TRUTHY_STRING,
+  icon: TRUTHY_STRING,
+  actions: {
+    [ACTION_NAME]: {
+      title: TRUTHY_STRING,
+      description: TRUTHY_STRING,
+      input: {
+        schema: import_sdk.z.object({
+          [PARAM_NAME]: import_sdk.z.string().title(TRUTHY_STRING).describe(TRUTHY_STRING)
+        }).title(TRUTHY_STRING).describe(TRUTHY_STRING)
+      },
+      output: {
+        schema: import_sdk.z.object({
+          [PARAM_NAME]: import_sdk.z.string().title(TRUTHY_STRING).describe(TRUTHY_STRING)
+        }).title(TRUTHY_STRING).describe(TRUTHY_STRING)
+      }
+    }
+  },
+  events: {
+    [EVENT_NAME]: {
+      title: TRUTHY_STRING,
+      description: TRUTHY_STRING,
+      schema: import_sdk.z.object({
+        [PARAM_NAME]: import_sdk.z.string().title(TRUTHY_STRING).describe(TRUTHY_STRING)
+      }).title(TRUTHY_STRING).describe(TRUTHY_STRING)
+    }
+  },
+  configuration: {
+    schema: import_sdk.z.object({
+      [PARAM_NAME]: import_sdk.z.string().title(TRUTHY_STRING).describe(TRUTHY_STRING)
+    }).title(TRUTHY_STRING).describe(TRUTHY_STRING)
+  },
+  configurations: {
+    [CONFIG_NAME]: {
+      title: TRUTHY_STRING,
+      description: TRUTHY_STRING,
+      schema: import_sdk.z.object({
+        [PARAM_NAME]: import_sdk.z.string().title(TRUTHY_STRING).describe(TRUTHY_STRING)
+      }).title(TRUTHY_STRING).describe(TRUTHY_STRING)
+    }
+  },
+  user: {
+    tags: {
+      [TAG_NAME]: {
+        title: TRUTHY_STRING,
+        description: TRUTHY_STRING
+      }
+    }
+  },
+  channels: {
+    [CHANNEL_NAME]: {
+      title: TRUTHY_STRING,
+      description: TRUTHY_STRING,
+      messages: {
+        [MESSAGE_TYPE]: {
+          schema: import_sdk.z.object({
+            [PARAM_NAME]: import_sdk.z.string().title(TRUTHY_STRING).describe(TRUTHY_STRING)
+          }).title(TRUTHY_STRING).describe(TRUTHY_STRING)
+        }
+      },
+      message: {
+        tags: {
+          [TAG_NAME]: {
+            title: TRUTHY_STRING,
+            description: TRUTHY_STRING
+          }
+        }
+      },
+      conversation: {
+        tags: {
+          [TAG_NAME]: {
+            title: TRUTHY_STRING,
+            description: TRUTHY_STRING
+          }
+        }
+      }
+    }
+  },
+  states: {
+    [STATE_NAME]: {
+      type: "integration",
+      schema: import_sdk.z.object({
+        [PARAM_NAME]: import_sdk.z.string().title(TRUTHY_STRING).describe(TRUTHY_STRING)
+      }).title(TRUTHY_STRING).describe(TRUTHY_STRING)
+    }
+  }
+};
+const mockLogger = {
+  log: import_vitest.vi.fn((message) => void 0),
+  warn: import_vitest.vi.fn((message) => void 0),
+  error: import_vitest.vi.fn((message) => void 0),
+  debug: import_vitest.vi.fn((message) => void 0)
+};
+const lintDefinition = async (definition) => {
+  const integrationDefinition = new import_sdk.IntegrationDefinition(definition);
+  const linter = new import_integration_linter.IntegrationLinter((0, import_integration_body.prepareCreateIntegrationBody)(integrationDefinition));
+  await linter.lint();
+  return linter;
+};
+const lintDefinitionAndReturnResults = async (definition) => {
+  const linter = await lintDefinition(definition);
+  return linter.getSortedResults();
+};
+const lintDefinitionAndLogResults = async (definition) => {
+  const linter = await lintDefinition(definition);
+  linter.logResults(mockLogger);
+};
+import_vitest.describe.concurrent("Integration Linter", () => {
+  (0, import_vitest.test)("should lint a valid definition without giving errors", async () => {
+    const definition = VALID_INTEGRATION;
+    const results = await lintDefinitionAndReturnResults(definition);
+    (0, import_vitest.expect)(results).toEqual([]);
+  });
+  (0, import_vitest.test)("should report an error when missing required fields", async () => {
+    const definition = {
+      ...VALID_INTEGRATION,
+      title: EMPTY_STRING
+    };
+    const results = await lintDefinitionAndReturnResults(definition);
+    (0, import_vitest.expect)(results[0]?.message).toContain("title");
+  });
+  (0, import_vitest.test)("should report an error when missing a title in an action input schema", async () => {
+    const definition = {
+      ...VALID_INTEGRATION,
+      actions: {
+        [ACTION_NAME]: {
+          ...VALID_INTEGRATION.actions[ACTION_NAME],
+          input: {
+            schema: import_sdk.z.object({
+              [PARAM_NAME]: import_sdk.z.string().describe(TRUTHY_STRING)
+            })
+          }
+        }
+      }
+    };
+    const results = await lintDefinitionAndReturnResults(definition);
+    (0, import_vitest.expect)(results[0]?.message).toContain("title");
+  });
+  (0, import_vitest.test)("should log as an error when severity is 0", async () => {
+    const definition = {
+      ...VALID_INTEGRATION,
+      title: EMPTY_STRING
+    };
+    await lintDefinitionAndLogResults(definition);
+    (0, import_vitest.expect)(mockLogger.error).toHaveBeenCalled();
+  });
+  (0, import_vitest.test)("should log as a warning when severity is 1", async () => {
+    const definition = {
+      ...VALID_INTEGRATION,
+      user: {
+        tags: {
+          [TAG_NAME]: {}
+        }
+      }
+    };
+    await lintDefinitionAndLogResults(definition);
+    (0, import_vitest.expect)(mockLogger.warn).toHaveBeenCalled();
+  });
+});
+//# sourceMappingURL=integration-linter.test.js.map

package/dist/linter/integration-linter.test.js.map

@@ -0,0 +1,7 @@
+{
+  "version": 3,
+  "sources": ["../../src/linter/integration-linter.test.ts"],
+  "sourcesContent": ["import { test, expect, describe, vi } from 'vitest'\nimport { prepareCreateIntegrationBody } from '../api/integration-body'\nimport { IntegrationLinter } from './integration-linter'\nimport { IntegrationDefinition, IntegrationDefinitionProps, z } from '@botpress/sdk'\nimport { Logger } from 'src/logger'\n\nconst EMPTY_STRING = ''\nconst TRUTHY_STRING = 'truthy'\nconst ACTION_NAME = 'actionName'\nconst EVENT_NAME = 'eventName'\nconst CONFIG_NAME = 'configName'\nconst PARAM_NAME = 'paramName'\nconst TAG_NAME = 'tagName'\nconst CHANNEL_NAME = 'channelName'\nconst STATE_NAME = 'stateName'\nconst MESSAGE_TYPE = 'text'\n\nconst VALID_INTEGRATION = {\n  name: TRUTHY_STRING,\n  title: TRUTHY_STRING,\n  description: TRUTHY_STRING,\n  version: TRUTHY_STRING,\n  readme: TRUTHY_STRING,\n  icon: TRUTHY_STRING,\n  actions: {\n    [ACTION_NAME]: {\n      title: TRUTHY_STRING,\n      description: TRUTHY_STRING,\n      input: {\n        schema: z\n          .object({\n            [PARAM_NAME]: z.string().title(TRUTHY_STRING).describe(TRUTHY_STRING),\n          })\n          .title(TRUTHY_STRING)\n          .describe(TRUTHY_STRING),\n      },\n      output: {\n        schema: z\n          .object({\n            [PARAM_NAME]: z.string().title(TRUTHY_STRING).describe(TRUTHY_STRING),\n          })\n          .title(TRUTHY_STRING)\n          .describe(TRUTHY_STRING),\n      },\n    },\n  },\n  events: {\n    [EVENT_NAME]: {\n      title: TRUTHY_STRING,\n      description: TRUTHY_STRING,\n      schema: z\n        .object({\n          [PARAM_NAME]: z.string().title(TRUTHY_STRING).describe(TRUTHY_STRING),\n        })\n        .title(TRUTHY_STRING)\n        .describe(TRUTHY_STRING),\n    },\n  },\n  configuration: {\n    schema: z\n      .object({\n        [PARAM_NAME]: z.string().title(TRUTHY_STRING).describe(TRUTHY_STRING),\n      })\n      .title(TRUTHY_STRING)\n      .describe(TRUTHY_STRING),\n  },\n  configurations: {\n    [CONFIG_NAME]: {\n      title: TRUTHY_STRING,\n      description: TRUTHY_STRING,\n      schema: z\n        .object({\n          [PARAM_NAME]: z.string().title(TRUTHY_STRING).describe(TRUTHY_STRING),\n        })\n        .title(TRUTHY_STRING)\n        .describe(TRUTHY_STRING),\n    },\n  },\n  user: {\n    tags: {\n      [TAG_NAME]: {\n        title: TRUTHY_STRING,\n        description: TRUTHY_STRING,\n      },\n    },\n  },\n  channels: {\n    [CHANNEL_NAME]: {\n      title: TRUTHY_STRING,\n      description: TRUTHY_STRING,\n      messages: {\n        [MESSAGE_TYPE]: {\n          schema: z\n            .object({\n              [PARAM_NAME]: z.string().title(TRUTHY_STRING).describe(TRUTHY_STRING),\n            })\n            .title(TRUTHY_STRING)\n            .describe(TRUTHY_STRING),\n        },\n      },\n      message: {\n        tags: {\n          [TAG_NAME]: {\n            title: TRUTHY_STRING,\n            description: TRUTHY_STRING,\n          },\n        },\n      },\n      conversation: {\n        tags: {\n          [TAG_NAME]: {\n            title: TRUTHY_STRING,\n            description: TRUTHY_STRING,\n          },\n        },\n      },\n    },\n  },\n  states: {\n    [STATE_NAME]: {\n      type: 'integration',\n      schema: z\n        .object({\n          [PARAM_NAME]: z.string().title(TRUTHY_STRING).describe(TRUTHY_STRING),\n        })\n        .title(TRUTHY_STRING)\n        .describe(TRUTHY_STRING),\n    },\n  },\n} as const satisfies IntegrationDefinitionProps\n\nconst mockLogger = {\n  log: vi.fn((message) => void message),\n  warn: vi.fn((message) => void message),\n  error: vi.fn((message) => void message),\n  debug: vi.fn((message) => void message),\n}\n\nconst lintDefinition = async (definition: IntegrationDefinitionProps) => {\n  const integrationDefinition = new IntegrationDefinition(definition)\n  const linter = new IntegrationLinter(prepareCreateIntegrationBody(integrationDefinition))\n  await linter.lint()\n  return linter\n}\n\nconst lintDefinitionAndReturnResults = async (definition: IntegrationDefinitionProps) => {\n  const linter = await lintDefinition(definition)\n  return linter.getSortedResults()\n}\n\nconst lintDefinitionAndLogResults = async (definition: IntegrationDefinitionProps) => {\n  const linter = await lintDefinition(definition)\n  linter.logResults(mockLogger as any)\n}\n\ndescribe.concurrent('Integration Linter', () => {\n  test('should lint a valid definition without giving errors', async () => {\n    // arrange\n    const definition = VALID_INTEGRATION\n\n    // act\n    const results = await lintDefinitionAndReturnResults(definition)\n\n    expect(results).toEqual([])\n  })\n\n  test('should report an error when missing required fields', async () => {\n    // arrange\n    const definition = {\n      ...VALID_INTEGRATION,\n      title: EMPTY_STRING,\n    } as const\n\n    // act\n    const results = await lintDefinitionAndReturnResults(definition)\n\n    // assert\n    expect(results[0]?.message).toContain('title')\n  })\n\n  test('should report an error when missing a title in an action input schema', async () => {\n    // arrange\n    const definition = {\n      ...VALID_INTEGRATION,\n      actions: {\n        [ACTION_NAME]: {\n          ...VALID_INTEGRATION.actions[ACTION_NAME],\n          input: {\n            schema: z.object({\n              [PARAM_NAME]: z.string().describe(TRUTHY_STRING),\n            }),\n          },\n        },\n      },\n    } as const\n\n    // act\n    const results = await lintDefinitionAndReturnResults(definition)\n\n    // assert\n    expect(results[0]?.message).toContain('title')\n  })\n\n  test('should log as an error when severity is 0', async () => {\n    // arrange\n    const definition = {\n      ...VALID_INTEGRATION,\n      title: EMPTY_STRING,\n    } as const\n\n    // act\n    await lintDefinitionAndLogResults(definition)\n\n    // assert\n    expect(mockLogger.error).toHaveBeenCalled()\n  })\n\n  test('should log as a warning when severity is 1', async () => {\n    // arrange\n    const definition = {\n      ...VALID_INTEGRATION,\n      user: {\n        tags: {\n          [TAG_NAME]: {},\n        },\n      },\n    } as const\n\n    // act\n    await lintDefinitionAndLogResults(definition)\n\n    // assert\n    expect(mockLogger.warn).toHaveBeenCalled()\n  })\n})\n"],
+  "mappings": ";AAAA,oBAA2C;AAC3C,8BAA6C;AAC7C,gCAAkC;AAClC,iBAAqE;AAGrE,MAAM,eAAe;AACrB,MAAM,gBAAgB;AACtB,MAAM,cAAc;AACpB,MAAM,aAAa;AACnB,MAAM,cAAc;AACpB,MAAM,aAAa;AACnB,MAAM,WAAW;AACjB,MAAM,eAAe;AACrB,MAAM,aAAa;AACnB,MAAM,eAAe;AAErB,MAAM,oBAAoB;AAAA,EACxB,MAAM;AAAA,EACN,OAAO;AAAA,EACP,aAAa;AAAA,EACb,SAAS;AAAA,EACT,QAAQ;AAAA,EACR,MAAM;AAAA,EACN,SAAS;AAAA,IACP,CAAC,cAAc;AAAA,MACb,OAAO;AAAA,MACP,aAAa;AAAA,MACb,OAAO;AAAA,QACL,QAAQ,aACL,OAAO;AAAA,UACN,CAAC,aAAa,aAAE,OAAO,EAAE,MAAM,aAAa,EAAE,SAAS,aAAa;AAAA,QACtE,CAAC,EACA,MAAM,aAAa,EACnB,SAAS,aAAa;AAAA,MAC3B;AAAA,MACA,QAAQ;AAAA,QACN,QAAQ,aACL,OAAO;AAAA,UACN,CAAC,aAAa,aAAE,OAAO,EAAE,MAAM,aAAa,EAAE,SAAS,aAAa;AAAA,QACtE,CAAC,EACA,MAAM,aAAa,EACnB,SAAS,aAAa;AAAA,MAC3B;AAAA,IACF;AAAA,EACF;AAAA,EACA,QAAQ;AAAA,IACN,CAAC,aAAa;AAAA,MACZ,OAAO;AAAA,MACP,aAAa;AAAA,MACb,QAAQ,aACL,OAAO;AAAA,QACN,CAAC,aAAa,aAAE,OAAO,EAAE,MAAM,aAAa,EAAE,SAAS,aAAa;AAAA,MACtE,CAAC,EACA,MAAM,aAAa,EACnB,SAAS,aAAa;AAAA,IAC3B;AAAA,EACF;AAAA,EACA,eAAe;AAAA,IACb,QAAQ,aACL,OAAO;AAAA,MACN,CAAC,aAAa,aAAE,OAAO,EAAE,MAAM,aAAa,EAAE,SAAS,aAAa;AAAA,IACtE,CAAC,EACA,MAAM,aAAa,EACnB,SAAS,aAAa;AAAA,EAC3B;AAAA,EACA,gBAAgB;AAAA,IACd,CAAC,cAAc;AAAA,MACb,OAAO;AAAA,MACP,aAAa;AAAA,MACb,QAAQ,aACL,OAAO;AAAA,QACN,CAAC,aAAa,aAAE,OAAO,EAAE,MAAM,aAAa,EAAE,SAAS,aAAa;AAAA,MACtE,CAAC,EACA,MAAM,aAAa,EACnB,SAAS,aAAa;AAAA,IAC3B;AAAA,EACF;AAAA,EACA,MAAM;AAAA,IACJ,MAAM;AAAA,MACJ,CAAC,WAAW;AAAA,QACV,OAAO;AAAA,QACP,aAAa;AAAA,MACf;AAAA,IACF;AAAA,EACF;AAAA,EACA,UAAU;AAAA,IACR,CAAC,eAAe;AAAA,MACd,OAAO;AAAA,MACP,aAAa;AAAA,MACb,UAAU;AAAA,QACR,CAAC,eAAe;AAAA,UACd,QAAQ,aACL,OAAO;AAAA,YACN,CAAC,aAAa,aAAE,OAAO,EAAE,MAAM,aAAa,EAAE,SAAS,aAAa;AAAA,UACtE,CAAC,EACA,MAAM,aAAa,EACnB,SAAS,aAAa;AAAA,QAC3B;AAAA,MACF;AAAA,MACA,SAAS;AAAA,QACP,MAAM;AAAA,UACJ,CAAC,WAAW;AAAA,YACV,OAAO;AAAA,YACP,aAAa;AAAA,UACf;AAAA,QACF;AAAA,MACF;AAAA,MACA,cAAc;AAAA,QACZ,MAAM;AAAA,UACJ,CAAC,WAAW;AAAA,YACV,OAAO;AAAA,YACP,aAAa;AAAA,UACf;AAAA,QACF;AAAA,MACF;AAAA,IACF;AAAA,EACF;AAAA,EACA,QAAQ;AAAA,IACN,CAAC,aAAa;AAAA,MACZ,MAAM;AAAA,MACN,QAAQ,aACL,OAAO;AAAA,QACN,CAAC,aAAa,aAAE,OAAO,EAAE,MAAM,aAAa,EAAE,SAAS,aAAa;AAAA,MACtE,CAAC,EACA,MAAM,aAAa,EACnB,SAAS,aAAa;AAAA,IAC3B;AAAA,EACF;AACF;AAEA,MAAM,aAAa;AAAA,EACjB,KAAK,iBAAG,GAAG,CAAC,YAAY,MAAY;AAAA,EACpC,MAAM,iBAAG,GAAG,CAAC,YAAY,MAAY;AAAA,EACrC,OAAO,iBAAG,GAAG,CAAC,YAAY,MAAY;AAAA,EACtC,OAAO,iBAAG,GAAG,CAAC,YAAY,MAAY;AACxC;AAEA,MAAM,iBAAiB,OAAO,eAA2C;AACvE,QAAM,wBAAwB,IAAI,iCAAsB,UAAU;AAClE,QAAM,SAAS,IAAI,gDAAkB,sDAA6B,qBAAqB,CAAC;AACxF,QAAM,OAAO,KAAK;AAClB,SAAO;AACT;AAEA,MAAM,iCAAiC,OAAO,eAA2C;AACvF,QAAM,SAAS,MAAM,eAAe,UAAU;AAC9C,SAAO,OAAO,iBAAiB;AACjC;AAEA,MAAM,8BAA8B,OAAO,eAA2C;AACpF,QAAM,SAAS,MAAM,eAAe,UAAU;AAC9C,SAAO,WAAW,UAAiB;AACrC;AAEA,uBAAS,WAAW,sBAAsB,MAAM;AAC9C,0BAAK,wDAAwD,YAAY;AAEvE,UAAM,aAAa;AAGnB,UAAM,UAAU,MAAM,+BAA+B,UAAU;AAE/D,8BAAO,OAAO,EAAE,QAAQ,CAAC,CAAC;AAAA,EAC5B,CAAC;AAED,0BAAK,uDAAuD,YAAY;AAEtE,UAAM,aAAa;AAAA,MACjB,GAAG;AAAA,MACH,OAAO;AAAA,IACT;AAGA,UAAM,UAAU,MAAM,+BAA+B,UAAU;AAG/D,8BAAO,QAAQ,IAAI,OAAO,EAAE,UAAU,OAAO;AAAA,EAC/C,CAAC;AAED,0BAAK,yEAAyE,YAAY;AAExF,UAAM,aAAa;AAAA,MACjB,GAAG;AAAA,MACH,SAAS;AAAA,QACP,CAAC,cAAc;AAAA,UACb,GAAG,kBAAkB,QAAQ;AAAA,UAC7B,OAAO;AAAA,YACL,QAAQ,aAAE,OAAO;AAAA,cACf,CAAC,aAAa,aAAE,OAAO,EAAE,SAAS,aAAa;AAAA,YACjD,CAAC;AAAA,UACH;AAAA,QACF;AAAA,MACF;AAAA,IACF;AAGA,UAAM,UAAU,MAAM,+BAA+B,UAAU;AAG/D,8BAAO,QAAQ,IAAI,OAAO,EAAE,UAAU,OAAO;AAAA,EAC/C,CAAC;AAED,0BAAK,6CAA6C,YAAY;AAE5D,UAAM,aAAa;AAAA,MACjB,GAAG;AAAA,MACH,OAAO;AAAA,IACT;AAGA,UAAM,4BAA4B,UAAU;AAG5C,8BAAO,WAAW,KAAK,EAAE,iBAAiB;AAAA,EAC5C,CAAC;AAED,0BAAK,8CAA8C,YAAY;AAE7D,UAAM,aAAa;AAAA,MACjB,GAAG;AAAA,MACH,MAAM;AAAA,QACJ,MAAM;AAAA,UACJ,CAAC,WAAW,CAAC;AAAA,QACf;AAAA,MACF;AAAA,IACF;AAGA,UAAM,4BAA4B,UAAU;AAG5C,8BAAO,WAAW,IAAI,EAAE,iBAAiB;AAAA,EAC3C,CAAC;AACH,CAAC;",
+  "names": []
+}