@forsakringskassan/vue-lib-template 1.2.0 → 1.2.1

package/files/docs/{kattinformation → guide}/index.md

@@ -3,6 +3,7 @@ title: Kattinformation
 status: Draft
 layout: component
 component: FcCatInfoComponent
+visible: false
 ---
 
 Komponenten kan visa kattdata i visningsläge eller i ett redigerbart läge.

package/files/docs/src/bundle-mocks.mjs

@@ -1,7 +1,7 @@
 import { matchRequest } from "@forsakringskassan/apimock-express/browser";
 import { http } from "msw";
 import { setupWorker } from "msw/browser";
-import mocks from "../../src/mocks.mts";
+import mocks from "../../src/mocks/index.mts";
 
 const handlers = [
     http.all("/api/*", async (req) => {

package/files/package.json

@@ -102,9 +102,9 @@
     "@forsakringskassan/eslint-config-vue": "15.9.8",
     "@forsakringskassan/prettier-config": "3.7.8",
     "@forsakringskassan/stylelint-config": "3.4.6",
-    "@forsakringskassan/vite-lib-config": "5.11.1",
+    "@forsakringskassan/vite-lib-config": "5.12.0",
     "@forsakringskassan/vitest-config-jsdom": "5.0.0",
-    "@forsakringskassan/vue-lib-template": "1.2.0",
+    "@forsakringskassan/vue-lib-template": "1.2.1",
     "@html-validate/release-scripts": "7.6.11",
     "@types/node": "24.13.4",
     "@typescript/native": "npm:typescript@7.0.2",

package/files/src/{FcCatInfoComponent.cy.ts → components/guide/FcCatInfo/FcCatInfoComponent.cy.ts}

@@ -1,7 +1,7 @@
 import { FLoaderSelectors } from "@fkui/vue/selectors";
+import { FcCatInfoComponentSelectors } from "../../../selectors/guide/FcCatInfoComponent.selectors";
 import FcCatInfoComponent from "./FcCatInfoComponent.vue";
 import { cats } from "./cat-data";
-import { FcCatInfoComponentSelectors } from "./selectors";
 
 describe("FcCatInfoComponent", () => {
     const testCat = cats[0];

package/files/src/{FcCatInfoComponent.vue → components/guide/FcCatInfo/FcCatInfoComponent.vue}

@@ -3,8 +3,8 @@ import { ref, watch } from "vue";
 import { FCard, FLoader } from "@fkui/vue";
 import CatInfoEdit from "./CatInfoEdit.vue";
 import CatInfoShow from "./CatInfoShow.vue";
-import { useCatInfo } from "./cat-info-logic";
-import { type Cat } from "./cat-types";
+import { useCatInfo } from "./cat-info-logic.js";
+import { type Cat } from "./cat-types.js";
 
 interface Props {
     /**

package/files/src/{FcCatInfoComponentLiveExample.vue → components/guide/FcCatInfo/examples/FcCatInfoComponentLiveExample.vue}

@@ -2,8 +2,8 @@
 import { defineComponent } from "vue";
 import { FCheckboxField, FSelectField } from "@fkui/vue";
 import { LiveExample } from "@forsakringskassan/docs-live-example";
-import FcCatInfoComponent from "./FcCatInfoComponent.vue";
-import { getCatIds } from "./cat-data";
+import FcCatInfoComponent from "../FcCatInfoComponent.vue";
+import { getCatIds } from "../cat-data.js";
 
 export default defineComponent({
     name: "FcCatInfoComponentLiveExample",
@@ -23,7 +23,9 @@ export default defineComponent({
             return this.isEditable ? " is-editable" : "";
         },
         template(): string {
-            return /* HTML */ ` <fc-cat-info-component cat-id="${this.selectedCatId}" ${this.editableAttr} /> `;
+            return /* HTML */ `
+                <fc-cat-info-component cat-id="${this.selectedCatId}" ${this.editableAttr} />
+            `;
         },
     },
 });

package/files/src/components/guide/FcCatInfo/index.ts

@@ -0,0 +1 @@
+export { default as FcCatInfoComponent } from "./FcCatInfoComponent.vue";

package/files/src/components/guide/README.md

@@ -0,0 +1,7 @@
+# Component guide
+
+This directory contains an example component, `FcCatInfoComponent`, that demonstrates the setup and conventions used by this template.
+It includes the component, selectors, tests, mock data, related support files, and belonging documentation in `docs/guide`.
+
+This guide will stay in sync when you update to later versions of your template,
+with intention to serve as a working reference while building your own components.

package/files/src/components/guide/index.ts

@@ -0,0 +1 @@
+export { FcCatInfoComponent } from "./FcCatInfo";

package/files/src/components/index.ts

@@ -0,0 +1 @@
+export * from "./guide";

package/files/src/index.ts

@@ -1,3 +1,3 @@
 import "./style.scss";
 
-export { default as FcCatInfoComponent } from "./FcCatInfoComponent.vue";
+export * from "./components";

package/files/src/{cat-api-mock.spec.ts → mocks/guide/cat-api-mock.spec.ts}

@@ -1,14 +1,12 @@
 import { matchRequest } from "@forsakringskassan/apimock-express/browser";
 import { describe, expect, it } from "vitest";
-import mocks from "./mocks.mjs";
+import catApiMock from "./cat-api.mock.mts";
 
 describe("Cat API Mock Reproduction", () => {
     it("should return 200 for a valid cat id /api/cat?id=whiskers-001", async () => {
         expect.assertions(2);
-        const req = new Request(
-            "http://localhost:8080/api/cat?id=whiskers-001",
-        );
-        const response = await matchRequest(mocks, req);
+        const req = new Request("http://localhost:8080/cat?id=whiskers-001");
+        const response = await matchRequest([catApiMock], req);
         expect(response.status).toBe(200);
 
         const data = await response.json();
@@ -17,8 +15,8 @@ describe("Cat API Mock Reproduction", () => {
 
     it("should return 404 for an invalid cat id /api/cat?id=unknown", async () => {
         expect.assertions(2);
-        const req = new Request("http://localhost:8080/api/cat?id=unknown");
-        const response = await matchRequest(mocks, req);
+        const req = new Request("http://localhost:8080/cat?id=unknown");
+        const response = await matchRequest([catApiMock], req);
         expect(response.status).toBe(404);
 
         const data = await response.json();

package/files/src/{cat-api.mock.mts → mocks/guide/cat-api.mock.mts}

@@ -1,6 +1,6 @@
 import { defineMock } from "@forsakringskassan/apimock-express/helpers";
-import { cats } from "./cat-data.ts";
-import type { Cat } from "./cat-types.ts";
+import { cats } from "../../components/guide/FcCatInfo/cat-data.ts";
+import type { Cat } from "../../components/guide/FcCatInfo/cat-types.ts";
 
 export default defineMock<Cat | { error: string }>({
     meta: {

package/files/src/mocks/index.mts

@@ -0,0 +1 @@
+export { default } from "./guide/index.mts";

package/files/src/selectors/guide/index.ts

@@ -0,0 +1 @@
+export { FcCatInfoComponentSelectors } from "./FcCatInfoComponent.selectors";

package/files/src/selectors/index.ts

@@ -1 +1 @@
-export { FcCatInfoComponentSelectors } from "./FcCatInfoComponent.selectors";
+export * from "./guide";

package/files/tsconfig.lib.json

@@ -3,17 +3,11 @@
 {
     "extends": "@forsakringskassan/vite-lib-config/tsconfig.lib.json",
     "compilerOptions": {
-        "allowImportingTsExtensions": true,
         "paths": {
             "@forsakringskassan/vue-lib-template/selectors": [
                 "./src/selectors/index.ts"
             ],
             "@forsakringskassan/vue-lib-template": ["./src/index.ts"]
         }
-    },
-    "include": [
-        "${configDir}/src/**/*.mts",
-        "${configDir}/src/**/*.ts",
-        "${configDir}/src/**/*.vue"
-    ]
+    }
 }

package/files/vite.config.mts

@@ -2,7 +2,7 @@
 
 import { defineConfig } from "@forsakringskassan/vite-lib-config/vite";
 import { defineTestConfig } from "@forsakringskassan/vitest-config-jsdom";
-import mocks from "./src/mocks.mts";
+import mocks from "./src/mocks/index.mts";
 
 export default defineConfig({
     test: defineTestConfig(),

package/index.js

@@ -7,7 +7,7 @@
 
         const options = {
             ...packageJson.cloneman,
-            fileHash: "36c8f49330d6acb55faacab6e563150ce680f321673ee1d5989144b469ef7839",
+            fileHash: "b15cb2f279a719719dfa19b85ed5587db8036c5e984ba398bce5a3cd69d0b0f5",
             filesDir: path.join(import.meta.dirname, "files"),
             hooksDir: path.join(import.meta.dirname, "hooks"),
         }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@forsakringskassan/vue-lib-template",
-  "version": "1.2.0",
+  "version": "1.2.1",
   "description": "Vue library template based on Cloneman",
   "keywords": [
     "template",
@@ -46,8 +46,8 @@
       "cypress/tsconfig.json",
       "cypress/types/mocha.d.ts",
       "docs/build.mts",
+      "docs/guide/index.md",
       "docs/index.md",
-      "docs/kattinformation/index.md",
       "docs/package.json",
       "docs/src/bundle-mocks.mjs",
       "docs/src/global.d.ts",
@@ -62,25 +62,31 @@
       "LICENSE.md",
       "README.md",
       "renovate.json",
-      "src/cat-api-mock.spec.ts",
-      "src/cat-api.mock.mts",
-      "src/cat-api.spec.ts",
-      "src/cat-api.ts",
-      "src/cat-data.ts",
-      "src/cat-info-logic.ts",
-      "src/cat-types.ts",
-      "src/CatInfoEdit.vue",
-      "src/CatInfoLogic.spec.ts",
-      "src/CatInfoShow.vue",
-      "src/examples/CatInfoExample.vue",
-      "src/FcCatInfoComponent.cy.ts",
-      "src/FcCatInfoComponent.vue",
-      "src/FcCatInfoComponentLiveExample.vue",
+      "src/components/guide/FcCatInfo/cat-api.spec.ts",
+      "src/components/guide/FcCatInfo/cat-api.ts",
+      "src/components/guide/FcCatInfo/cat-data.ts",
+      "src/components/guide/FcCatInfo/cat-info-logic.spec.ts",
+      "src/components/guide/FcCatInfo/cat-info-logic.ts",
+      "src/components/guide/FcCatInfo/cat-types.ts",
+      "src/components/guide/FcCatInfo/CatInfoEdit.vue",
+      "src/components/guide/FcCatInfo/CatInfoShow.vue",
+      "src/components/guide/FcCatInfo/examples/FcCatInfoComponentExample.vue",
+      "src/components/guide/FcCatInfo/examples/FcCatInfoComponentLiveExample.vue",
+      "src/components/guide/FcCatInfo/FcCatInfoComponent.cy.ts",
+      "src/components/guide/FcCatInfo/FcCatInfoComponent.vue",
+      "src/components/guide/FcCatInfo/index.ts",
+      "src/components/guide/index.ts",
+      "src/components/guide/README.md",
+      "src/components/index.ts",
       "src/index.ts",
       "src/local.scss",
       "src/local.ts",
-      "src/mocks.mts",
-      "src/selectors/FcCatInfoComponent.selectors.ts",
+      "src/mocks/guide/cat-api-mock.spec.ts",
+      "src/mocks/guide/cat-api.mock.mts",
+      "src/mocks/guide/index.mts",
+      "src/mocks/index.mts",
+      "src/selectors/guide/FcCatInfoComponent.selectors.ts",
+      "src/selectors/guide/index.ts",
       "src/selectors/index.ts",
       "src/style.scss",
       "src/vite-dev/app.vue",