@carlonicora/nextjs-jsonapi 1.108.0 → 1.110.0

package/dist/chunk-WPAQRB5Q.mjs

@@ -0,0 +1,7 @@
+// src/features/help/types/help-article.types.ts
+var HELP_MODES = ["tutorial", "how-to", "reference", "explanation"];
+
+export {
+  HELP_MODES
+};
+//# sourceMappingURL=chunk-WPAQRB5Q.mjs.map

package/dist/chunk-WPAQRB5Q.mjs.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../src/features/help/types/help-article.types.ts"],"sourcesContent":["/**\n * Help-article types for the frontend help feature. Self-contained — the\n * published frontend library stays decoupled from `@carlonicora/nestjs-neo4jsonapi`.\n */\n\nexport const HELP_MODES = [\"tutorial\", \"how-to\", \"reference\", \"explanation\"] as const;\nexport type HelpMode = (typeof HELP_MODES)[number];\n\nexport interface HelpHeading {\n  depth: 2 | 3;\n  slug: string;\n  text: string;\n}\n\nexport interface HelpArticle {\n  id: string;\n  slug: string;\n  mode: HelpMode;\n  title: string;\n  summary: string;\n  order: number;\n  tags: readonly string[];\n  contextualKeys: readonly string[];\n  aiIndexed: boolean;\n  draft: boolean;\n  path: string;\n  headings: readonly HelpHeading[];\n  relatedSlugs: readonly string[];\n  lastUpdated: string;\n}\n\nexport interface HelpRedirect {\n  from: string;\n  to: string;\n}\n"],"mappings":";AAKO,IAAM,aAAa,CAAC,YAAY,UAAU,aAAa,aAAa;","names":[]}

package/dist/chunk-YBZVWLPH.js

@@ -0,0 +1,7 @@
+"use strict";Object.defineProperty(exports, "__esModule", {value: true});// src/features/help/types/help-article.types.ts
+var HELP_MODES = ["tutorial", "how-to", "reference", "explanation"];
+
+
+
+exports.HELP_MODES = HELP_MODES;
+//# sourceMappingURL=chunk-YBZVWLPH.js.map

package/dist/chunk-YBZVWLPH.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["/home/runner/work/nextjs-jsonapi/nextjs-jsonapi/dist/chunk-YBZVWLPH.js","../src/features/help/types/help-article.types.ts"],"names":[],"mappings":"AAAA;ACKO,IAAM,WAAA,EAAa,CAAC,UAAA,EAAY,QAAA,EAAU,WAAA,EAAa,aAAa,CAAA;ADH3E;AACA;AACE;AACF,gCAAC","file":"/home/runner/work/nextjs-jsonapi/nextjs-jsonapi/dist/chunk-YBZVWLPH.js","sourcesContent":[null,"/**\n * Help-article types for the frontend help feature. Self-contained — the\n * published frontend library stays decoupled from `@carlonicora/nestjs-neo4jsonapi`.\n */\n\nexport const HELP_MODES = [\"tutorial\", \"how-to\", \"reference\", \"explanation\"] as const;\nexport type HelpMode = (typeof HELP_MODES)[number];\n\nexport interface HelpHeading {\n  depth: 2 | 3;\n  slug: string;\n  text: string;\n}\n\nexport interface HelpArticle {\n  id: string;\n  slug: string;\n  mode: HelpMode;\n  title: string;\n  summary: string;\n  order: number;\n  tags: readonly string[];\n  contextualKeys: readonly string[];\n  aiIndexed: boolean;\n  draft: boolean;\n  path: string;\n  headings: readonly HelpHeading[];\n  relatedSlugs: readonly string[];\n  lastUpdated: string;\n}\n\nexport interface HelpRedirect {\n  from: string;\n  to: string;\n}\n"]}

package/dist/{chunk-N3NVIPSU.mjs → chunk-ZYPNVEHB.mjs}

@@ -5256,6 +5256,13 @@ var HowTo = class extends Content {
   }
   _description;
   _pages;
+  _howToType;
+  _slug;
+  _order;
+  _summary;
+  _tags;
+  _contextualKeys;
+  _draft;
   /**
    * Parse pages from backend JSON string (handles legacy single string + JSON array)
    */
@@ -5281,10 +5288,49 @@ var HowTo = class extends Content {
   get pages() {
     return this._pages;
   }
+  get howToType() {
+    return this._howToType;
+  }
+  get slug() {
+    return this._slug;
+  }
+  get order() {
+    return this._order;
+  }
+  get summary() {
+    return this._summary;
+  }
+  get tags() {
+    return this._tags ?? [];
+  }
+  get contextualKeys() {
+    return this._contextualKeys ?? [];
+  }
+  get draft() {
+    return this._draft ?? false;
+  }
   rehydrate(data) {
     super.rehydrate(data);
-    this._description = data.jsonApi.attributes.description ? JSON.parse(data.jsonApi.attributes.description) : void 0;
+    const rawDescription = data.jsonApi.attributes.description;
+    if (rawDescription === void 0 || rawDescription === null || rawDescription === "") {
+      this._description = void 0;
+    } else if (typeof rawDescription === "string") {
+      try {
+        this._description = JSON.parse(rawDescription);
+      } catch {
+        this._description = rawDescription;
+      }
+    } else {
+      this._description = rawDescription;
+    }
     this._pages = data.jsonApi.attributes.pages;
+    this._howToType = data.jsonApi.attributes.howToType;
+    this._slug = data.jsonApi.attributes.slug;
+    this._order = data.jsonApi.attributes.order;
+    this._summary = data.jsonApi.attributes.summary;
+    this._tags = data.jsonApi.attributes.tags ?? [];
+    this._contextualKeys = data.jsonApi.attributes.contextualKeys ?? [];
+    this._draft = data.jsonApi.attributes.draft ?? false;
     return this;
   }
   createJsonApi(data) {
@@ -5301,6 +5347,13 @@ var HowTo = class extends Content {
     super.addContentInput(response, data);
     if (data.description !== void 0) response.data.attributes.description = JSON.stringify(data.description);
     if (data.pages !== void 0) response.data.attributes.pages = data.pages;
+    if (data.howToType !== void 0) response.data.attributes.howToType = data.howToType;
+    if (data.slug !== void 0) response.data.attributes.slug = data.slug;
+    if (data.order !== void 0) response.data.attributes.order = data.order;
+    if (data.summary !== void 0) response.data.attributes.summary = data.summary;
+    if (data.tags !== void 0) response.data.attributes.tags = data.tags;
+    if (data.contextualKeys !== void 0) response.data.attributes.contextualKeys = data.contextualKeys;
+    if (data.draft !== void 0) response.data.attributes.draft = data.draft;
     return response;
   }
 };
@@ -5314,7 +5367,20 @@ var HowToModule = /* @__PURE__ */ __name((factory) => factory({
   icon: LifeBuoyIcon,
   inclusions: {
     lists: {
-      fields: [createJsonApiInclusion("howtos", [`name`, `description`, `pages`])]
+      fields: [
+        createJsonApiInclusion("howtos", [
+          "name",
+          "description",
+          "pages",
+          "howToType",
+          "slug",
+          "order",
+          "summary",
+          "tags",
+          "contextualKeys",
+          "draft"
+        ])
+      ]
     }
   }
 }), "HowToModule");
@@ -5378,6 +5444,62 @@ var HowToService = class extends AbstractService {
       endpoint: new EndpointCreator({ endpoint: Modules.HowTo, id: params.howToId }).generate()
     });
   }
+  static async findPublished(params = {}) {
+    const endpoint = new EndpointCreator({ endpoint: `public/${Modules.HowTo.name}` });
+    if (params.howToType) endpoint.addAdditionalParam("type", params.howToType);
+    return this.callApi({
+      type: Modules.HowTo,
+      method: "GET" /* GET */,
+      endpoint: endpoint.generate()
+    });
+  }
+  static async findPublishedArticle(params) {
+    return this.callApi({
+      type: Modules.HowTo,
+      method: "GET" /* GET */,
+      endpoint: new EndpointCreator({
+        endpoint: `public/${Modules.HowTo.name}`,
+        id: params.howToType,
+        childEndpoint: params.slug
+      }).generate()
+    });
+  }
+  static async findRelated(params) {
+    return this.callApi({
+      type: Modules.HowTo,
+      method: "GET" /* GET */,
+      endpoint: new EndpointCreator({
+        endpoint: `public/${Modules.HowTo.name}`,
+        id: params.howToType,
+        childEndpoint: params.slug,
+        childId: "related"
+      }).generate()
+    });
+  }
+  static async addRelated(params) {
+    return this.callApi({
+      type: Modules.HowTo,
+      method: "POST" /* POST */,
+      endpoint: new EndpointCreator({
+        endpoint: Modules.HowTo,
+        id: params.howToId,
+        childEndpoint: "related",
+        childId: params.relatedId
+      }).generate()
+    });
+  }
+  static async removeRelated(params) {
+    await this.callApi({
+      type: Modules.HowTo,
+      method: "DELETE" /* DELETE */,
+      endpoint: new EndpointCreator({
+        endpoint: Modules.HowTo,
+        id: params.howToId,
+        childEndpoint: "related",
+        childId: params.relatedId
+      }).generate()
+    });
+  }
 };
 
 // src/features/assistant/AssistantModule.ts
@@ -5410,7 +5532,9 @@ var Assistant = class extends AbstractApiData {
         type: Modules.Assistant.name,
         attributes: {
           content: data.firstMessage,
-          ...data.title !== void 0 ? { title: data.title } : {}
+          ...data.title !== void 0 ? { title: data.title } : {},
+          ...data.howToMode !== void 0 ? { howToMode: data.howToMode } : {},
+          ...data.limitToHowToId !== void 0 ? { limitToHowToId: data.limitToHowToId } : {}
         }
       },
       included: []
@@ -5433,83 +5557,8 @@ var AssistantModule = /* @__PURE__ */ __name((factory) => factory({
   }
 }), "AssistantModule");
 
-// src/features/assistant/data/AssistantService.ts
-var AssistantService = class extends AbstractService {
-  static {
-    __name(this, "AssistantService");
-  }
-  static async findOne(params) {
-    return this.callApi({
-      type: Modules.Assistant,
-      method: "GET" /* GET */,
-      endpoint: new EndpointCreator({ endpoint: Modules.Assistant, id: params.id }).generate()
-    });
-  }
-  static async findMany(params = {}) {
-    const endpoint = new EndpointCreator({ endpoint: Modules.Assistant });
-    if (params.fetchAll) endpoint.addAdditionalParam("fetchAll", "true");
-    return this.callApi({
-      type: Modules.Assistant,
-      method: "GET" /* GET */,
-      endpoint: endpoint.generate()
-    });
-  }
-  static async create(params) {
-    return this.callApi({
-      type: Modules.Assistant,
-      method: "POST" /* POST */,
-      endpoint: new EndpointCreator({ endpoint: Modules.Assistant }).generate(),
-      input: params
-    });
-  }
-  /**
-   * Sends a new user message to an existing assistant thread. The agent turn
-   * runs synchronously; the response is a two-element list: [user, assistant].
-   */
-  static async appendMessage(params) {
-    return this.callApi({
-      type: Modules.AssistantMessage,
-      method: "POST" /* POST */,
-      endpoint: new EndpointCreator({
-        endpoint: Modules.Assistant,
-        id: params.assistantId,
-        childEndpoint: Modules.AssistantMessage
-      }).generate(),
-      input: {
-        data: {
-          type: Modules.AssistantMessage.name,
-          attributes: { content: params.content }
-        }
-      },
-      overridesJsonApiCreation: true
-    });
-  }
-  static async rename(params) {
-    await this.callApi({
-      type: Modules.Assistant,
-      method: "PATCH" /* PATCH */,
-      endpoint: new EndpointCreator({ endpoint: Modules.Assistant, id: params.id }).generate(),
-      input: {
-        data: {
-          type: Modules.Assistant.name,
-          id: params.id,
-          attributes: { title: params.title }
-        }
-      },
-      overridesJsonApiCreation: true
-    });
-  }
-  static async delete(params) {
-    await this.callApi({
-      type: Modules.Assistant,
-      method: "DELETE" /* DELETE */,
-      endpoint: new EndpointCreator({ endpoint: Modules.Assistant, id: params.id }).generate()
-    });
-  }
-};
-
-// src/features/assistant-message/AssistantMessageModule.ts
-import { MessageSquareIcon } from "lucide-react";
+// src/features/assistant-message/data/AssistantMessage.ts
+import { v4 as uuidv4 } from "uuid";
 
 // src/features/assistant/utils/resolveReferenceableModules.ts
 function resolveReferenceableModules() {
@@ -5533,6 +5582,7 @@ var AssistantMessage = class _AssistantMessage extends AbstractApiData {
   _outputTokens;
   _references;
   _citations;
+  _isOptimistic = false;
   get role() {
     return this._role ?? "assistant";
   }
@@ -5557,6 +5607,9 @@ var AssistantMessage = class _AssistantMessage extends AbstractApiData {
   get citations() {
     return this._citations ?? [];
   }
+  get isOptimistic() {
+    return this._isOptimistic;
+  }
   rehydrate(data) {
     super.rehydrate(data);
     const attrs = data.jsonApi.attributes ?? {};
@@ -5599,10 +5652,28 @@ var AssistantMessage = class _AssistantMessage extends AbstractApiData {
       included: []
     };
   }
+  /**
+   * JSON:API envelope for POST /assistants/:id/assistant-messages.
+   * Different from `createJsonApi` (which expects a full message with role/position/assistant ref);
+   * the append-to-thread endpoint derives those server-side, so we only send `content` and
+   * the optional retrieval-mode flags.
+   */
+  createAppendMessageJsonApi(params) {
+    return {
+      data: {
+        type: Modules.AssistantMessage.name,
+        attributes: {
+          content: params.content,
+          ...params.howToMode !== void 0 ? { howToMode: params.howToMode } : {},
+          ...params.limitToHowToId !== void 0 ? { limitToHowToId: params.limitToHowToId } : {}
+        }
+      }
+    };
+  }
   static buildOptimistic(params) {
     const msg = new _AssistantMessage();
     const jsonApi = {
-      id: `tmp-${crypto.randomUUID()}`,
+      id: uuidv4(),
       type: Modules.AssistantMessage.name,
       attributes: {
         role: "user",
@@ -5616,11 +5687,92 @@ var AssistantMessage = class _AssistantMessage extends AbstractApiData {
       };
     }
     msg.rehydrate({ jsonApi, included: [] });
+    msg._isOptimistic = true;
     return msg;
   }
 };
 
+// src/features/assistant/data/AssistantService.ts
+var AssistantService = class extends AbstractService {
+  static {
+    __name(this, "AssistantService");
+  }
+  static async findOne(params) {
+    return this.callApi({
+      type: Modules.Assistant,
+      method: "GET" /* GET */,
+      endpoint: new EndpointCreator({ endpoint: Modules.Assistant, id: params.id }).generate()
+    });
+  }
+  static async findMany(params = {}) {
+    const endpoint = new EndpointCreator({ endpoint: Modules.Assistant });
+    if (params.fetchAll) endpoint.addAdditionalParam("fetchAll", "true");
+    return this.callApi({
+      type: Modules.Assistant,
+      method: "GET" /* GET */,
+      endpoint: endpoint.generate()
+    });
+  }
+  static async create(params) {
+    return this.callApi({
+      type: Modules.Assistant,
+      method: "POST" /* POST */,
+      endpoint: new EndpointCreator({ endpoint: Modules.Assistant }).generate(),
+      input: params
+    });
+  }
+  /**
+   * Sends a new user message to an existing assistant thread. The agent turn
+   * runs synchronously; the response is a two-element list: [user, assistant].
+   *
+   * Uses the dedicated AssistantMessage.createAppendMessageJsonApi method to
+   * build the JSON:API envelope; this is the architecture-compliant pairing
+   * with `overridesJsonApiCreation: true`.
+   */
+  static async appendMessage(params) {
+    const message = new AssistantMessage();
+    return this.callApi({
+      type: Modules.AssistantMessage,
+      method: "POST" /* POST */,
+      endpoint: new EndpointCreator({
+        endpoint: Modules.Assistant,
+        id: params.assistantId,
+        childEndpoint: Modules.AssistantMessage
+      }).generate(),
+      input: message.createAppendMessageJsonApi({
+        content: params.content,
+        howToMode: params.howToMode,
+        limitToHowToId: params.limitToHowToId
+      }),
+      overridesJsonApiCreation: true
+    });
+  }
+  static async rename(params) {
+    await this.callApi({
+      type: Modules.Assistant,
+      method: "PATCH" /* PATCH */,
+      endpoint: new EndpointCreator({ endpoint: Modules.Assistant, id: params.id }).generate(),
+      input: {
+        data: {
+          type: Modules.Assistant.name,
+          id: params.id,
+          attributes: { title: params.title }
+        }
+      },
+      overridesJsonApiCreation: true
+    });
+  }
+  static async delete(params) {
+    await this.callApi({
+      type: Modules.Assistant,
+      method: "DELETE" /* DELETE */,
+      endpoint: new EndpointCreator({ endpoint: Modules.Assistant, id: params.id }).generate()
+    });
+  }
+};
+
 // src/features/assistant-message/AssistantMessageModule.ts
+import { MessageSquareIcon } from "lucide-react";
 var AssistantMessageModule = /* @__PURE__ */ __name((factory) => factory({
   pageUrl: "/assistant-messages",
   name: "assistant-messages",
@@ -7564,8 +7716,8 @@ export {
   HowToService,
   Assistant,
   AssistantModule,
-  AssistantService,
   AssistantMessage,
+  AssistantService,
   AssistantMessageModule,
   AssistantMessageService,
   Chunk,
@@ -7619,4 +7771,4 @@ export {
   AuditLogService,
   AuditLogModule
 };
-//# sourceMappingURL=chunk-N3NVIPSU.mjs.map
+//# sourceMappingURL=chunk-ZYPNVEHB.mjs.map