@camox/api-contract 0.7.1

package/dist/index.js

@@ -0,0 +1 @@
+// type-only module

package/dist/query-keys.d.ts

@@ -0,0 +1,33 @@
+/**
+ * Use TypeScript to enforce 'camox' as the first query key to ensure they're all namespaced.
+ * This is because the Tanstack Query client on the frontend may be shared with the user's routes,
+ * so we ensure there won't be any key collisions.
+ */
+export type QueryKey = [first: "camox", ...rest: Array<string | number>];
+export declare const queryKeys: {
+    pages: {
+        list: ["camox", string, string];
+        getByPath: (path: string) => ["camox", string, string, string];
+        getByPathAll: ["camox", string, string];
+        getById: (id: number) => ["camox", string, string, number];
+    };
+    files: {
+        list: ["camox", string, string];
+        get: (id: number) => ["camox", string, string, number];
+    };
+    blocks: {
+        get: (id: number) => ["camox", string, string, number];
+        getUsageCounts: ["camox", string, string];
+        getPageMarkdown: (pageId: number) => ["camox", string, string, number];
+    };
+    repeatableItems: {
+        get: (id: number) => ["camox", string, string, number];
+    };
+    layouts: {
+        all: ["camox", string];
+    };
+};
+export type InvalidationMessage = {
+    type: "invalidate";
+    targets: QueryKey[];
+};

package/dist/query-keys.js

@@ -0,0 +1,23 @@
+export const queryKeys = {
+    pages: {
+        list: ["camox", "pages", "list"],
+        getByPath: (path) => ["camox", "pages", "getByPath", path],
+        getByPathAll: ["camox", "pages", "getByPath"],
+        getById: (id) => ["camox", "pages", "getById", id],
+    },
+    files: {
+        list: ["camox", "files", "list"],
+        get: (id) => ["camox", "files", "get", id],
+    },
+    blocks: {
+        get: (id) => ["camox", "blocks", "get", id],
+        getUsageCounts: ["camox", "blocks", "getUsageCounts"],
+        getPageMarkdown: (pageId) => ["camox", "blocks", "getPageMarkdown", pageId],
+    },
+    repeatableItems: {
+        get: (id) => ["camox", "repeatableItems", "get", id],
+    },
+    layouts: {
+        all: ["camox", "layouts"],
+    },
+};

package/package.json

@@ -0,0 +1,25 @@
+{
+  "name": "@camox/api-contract",
+  "version": "0.7.1",
+  "files": [
+    "src",
+    "dist"
+  ],
+  "type": "module",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "default": "./dist/index.js"
+    },
+    "./query-keys": {
+      "types": "./dist/query-keys.d.ts",
+      "default": "./dist/query-keys.js"
+    }
+  },
+  "devDependencies": {
+    "dts-bundle-generator": "^9.5.1"
+  },
+  "scripts": {
+    "build": "node build.mjs"
+  }
+}

package/src/index.ts

@@ -0,0 +1 @@
+export type { Router } from "../../../apps/api/src/router";

package/src/query-keys.ts

@@ -0,0 +1,36 @@
+/**
+ * Use TypeScript to enforce 'camox' as the first query key to ensure they're all namespaced.
+ * This is because the Tanstack Query client on the frontend may be shared with the user's routes,
+ * so we ensure there won't be any key collisions.
+ */
+export type QueryKey = [first: "camox", ...rest: Array<string | number>];
+type QueryKeyGroup = Record<string, QueryKey | ((...args: any[]) => QueryKey)>;
+
+export const queryKeys = {
+  pages: {
+    list: ["camox", "pages", "list"],
+    getByPath: (path: string) => ["camox", "pages", "getByPath", path],
+    getByPathAll: ["camox", "pages", "getByPath"],
+    getById: (id: number) => ["camox", "pages", "getById", id],
+  },
+  files: {
+    list: ["camox", "files", "list"],
+    get: (id: number) => ["camox", "files", "get", id],
+  },
+  blocks: {
+    get: (id: number) => ["camox", "blocks", "get", id],
+    getUsageCounts: ["camox", "blocks", "getUsageCounts"],
+    getPageMarkdown: (pageId: number) => ["camox", "blocks", "getPageMarkdown", pageId],
+  },
+  repeatableItems: {
+    get: (id: number) => ["camox", "repeatableItems", "get", id],
+  },
+  layouts: {
+    all: ["camox", "layouts"],
+  },
+} satisfies Record<string, QueryKeyGroup>;
+
+export type InvalidationMessage = {
+  type: "invalidate";
+  targets: QueryKey[];
+};