@umami/shiso 0.1.0

package/src/content/docs/writing-content.mdx

@@ -0,0 +1,95 @@
+---
+title: Tracker functions
+---
+
+The Umami tracker exposes a function that you can call on your website if you want
+more control over your tracking. By default everything is automatically collected, but you can
+disable this using `data-auto-track="false"` and sending the data yourself.
+See [Tracker configuration](/docs/tracker-configuration).
+
+## Functions
+
+```js
+umami.track(payload: object);
+
+umami.track(event_name: string, event_data: object);
+
+umami.identify(session_data: object);
+```
+
+## Pageviews
+
+Tracks a page view.
+
+```js
+umami.track();
+```
+
+By default the tracker automatically collects the following properties:
+
+- `hostname` - Hostname of server
+- `language` - Browser language
+- `referrer` - Page referrer
+- `screen` - Screen dimensions (eg. 1920x1080)
+- `title` - Page title
+- `url` - Page url
+- `website` - Website ID (required)
+
+If you wish to send your own custom payload, pass in an object to the function:
+
+```js
+umami.track({ website: 'e676c9b4-11e4-4ef1-a4d7-87001773e9f2', url: '/home', title: 'Home page' });
+```
+
+The above will only send the properties `website`, `url` and `title`. If you want to include existing properties, pass in a function:
+
+```js
+umami.track(props => ({ ...props, url: '/home', title: 'Home page' }));
+```
+
+## Events
+
+Tracks an event with a given name.
+
+```js
+umami.track('signup-button');
+```
+
+## Event Data
+
+Tracks an event with dynamic data.
+
+```js
+umami.track('signup-button', { name: 'newsletter', id: 123 });
+```
+
+When tracking events, the default properties are included in the payload.
+This is equivalent to running:
+
+```js
+umami.track(props => ({
+  ...props,
+  name: 'signup-button',
+  data: {
+    name: 'newsletter',
+    id: 123,
+  },
+}));
+```
+
+## Event Data Limits
+
+Event Data can work with any JSON data. There are a few rules in place to maintain performance.
+
+- Numbers have a max precision of 4.
+- Strings have a max length of 500.
+- Arrays are converted to a String, with the same max length of 500.
+- Objects have a max of 50 properties. Arrays are considered 1 property.
+
+## Session Data
+
+Tracks a session with dynamic data. You would call the identity function from the tracker script to save data about the current session.
+
+```js
+umami.identify({ email: 'bob@aol.com' });
+```

package/src/declarations.d.ts

@@ -0,0 +1,3 @@
+declare module 'recursive-readdir';
+declare module '*.json';
+declare module '*.module.css';

package/src/index.ts

@@ -0,0 +1,5 @@
+import { Blog } from '@/components/blog/Blog';
+import { Docs } from '@/components/docs/Docs';
+import * as next from '@/lib/next';
+
+export { Blog, Docs, next };

package/src/lib/content.ts

@@ -0,0 +1,61 @@
+import { cache } from 'react';
+import matter from 'gray-matter';
+import recursive from 'recursive-readdir';
+import { firstBy } from 'thenby';
+import fs from 'node:fs/promises';
+import path from 'node:path';
+
+export const getFiles = cache(async (folder: string) => {
+  const dir = path.resolve(folder);
+  const files = await recursive(dir);
+
+  return Promise.all(
+    files
+      .filter((file: string) => path.extname(file) === '.mdx')
+      .map(async (file: string) => {
+        const postContent = await fs.readFile(file, 'utf8');
+        const { data, content } = matter(postContent);
+
+        const id = file.replace('.mdx', '').replace(dir, '').replace(/\\/g, '/').replace(/^\//, '');
+        const anchors: { name: string; id: string; size: number }[] = [];
+        const body = content
+          .split('\n')
+          .map(line => {
+            const match = line.match(/(#+)\s+(.*)/);
+            if (match) {
+              const [, num, name] = match;
+              const id = name.toLowerCase().replace(/\s+/g, '-');
+              const size = num.length;
+
+              anchors.push({ name, id, size });
+
+              return `<h${size} id="${id}">${name.replace(/\{|\}/g, '')}</h${size}>`;
+            }
+            return line;
+          })
+          .join('\n');
+
+        return {
+          meta: data,
+          id,
+          body,
+          anchors,
+        } as any;
+      }),
+  ).then(posts => posts.sort(firstBy('date', 'desc')));
+});
+
+export async function getFile(id: string, folder: string) {
+  const files = await getFiles(folder);
+
+  return files.find(file => file?.id === id);
+}
+
+export async function getContent(params: { id: string[] }, folder: string) {
+  const { id = [] } = params;
+  const name = id?.length ? id.join('/') : 'index';
+
+  return getFile(name, folder);
+}
+
+export default getFile;

package/src/lib/next.tsx

@@ -0,0 +1,46 @@
+import { Metadata } from 'next';
+import path from 'node:path';
+import { Docs } from '@/components/docs/Docs';
+import { Blog } from '@/components/blog/Blog';
+import { getContent } from '@/lib/content';
+import { ShisoConfig } from '@/components/Shiso';
+
+const DEFAULT_CONTENT_DIR = './src/content';
+
+const components = {
+  docs: Docs,
+  blog: Blog,
+};
+
+export default (config: ShisoConfig) => {
+  const { contentDir = DEFAULT_CONTENT_DIR } = config || {};
+
+  const getMetadata = ({ title }: { title: string }) => {
+    return async ({ params }: { params: Promise<{ id: string[] }> }): Promise<Metadata> => {
+      const content = await getContent(await params, contentDir);
+
+      return {
+        title: {
+          absolute: `${content?.meta?.title} – ${title}`,
+          default: title,
+        },
+      };
+    };
+  };
+
+  const renderPage = ({ type }: { type: string }) => {
+    const folder = path.resolve(process.cwd(), contentDir, type);
+
+    return async ({ params }: { params: Promise<{ id: string[] }> }) => {
+      const content = await getContent(await params, folder);
+      const Component = components[type];
+
+      return Component && <Component content={content} config={config} />;
+    };
+  };
+
+  return {
+    getMetadata,
+    renderPage,
+  };
+};

package/src/lib/types.ts

@@ -0,0 +1,10 @@
+export interface ShisoDocsConfig {
+  tabs?: [];
+}
+
+export interface ShisoBlogConfig {}
+
+export interface ShisoConfig {
+  docs?: { [key: string]: any };
+  blog?: { [key: string]: any };
+}

package/src/shiso.config.json

@@ -0,0 +1,59 @@
+{
+  "contentDir": "./src/content",
+  "docs": {
+    "title": "Shiso",
+    "tabs": [
+      {
+        "id": "docs",
+        "label": "Documentation",
+        "url": "/docs"
+      },
+      {
+        "id": "components",
+        "label": "Components",
+        "url": "/docs/components"
+      }
+    ],
+    "navigation": {
+      "docs": [
+        {
+          "group": "Getting started",
+          "pages": [
+            {
+              "label": "Overview",
+              "url": "/docs"
+            },
+            {
+              "label": "Installation",
+              "url": "/docs/installation"
+            },
+            {
+              "label": "Configuration",
+              "url": "/docs/configuration"
+            }
+          ]
+        },
+        {
+          "group": "Basics",
+          "pages": [
+            {
+              "label": "Writing content",
+              "url": "/docs/writing-content"
+            }
+          ]
+        }
+      ],
+      "components": [
+        {
+          "group": "Components",
+          "pages": [
+            {
+              "label": "Overview",
+              "url": "/docs/components"
+            }
+          ]
+        }
+      ]
+    }
+  }
+}

package/tsconfig.build.json

@@ -0,0 +1,24 @@
+{
+  "compilerOptions": {
+    "declaration": true,
+    "noImplicitAny": false,
+    "emitDeclarationOnly": true,
+    "esModuleInterop": true,
+    "allowJs": true,
+    "skipLibCheck": true,
+    "strict": true,
+    "isolatedModules": true,
+    "rootDir": "./src",
+    "outDir": "./types",
+    "module": "esnext",
+    "moduleResolution": "bundler",
+    "lib": ["dom", "dom.iterable", "esnext"],
+    "jsx": "preserve",
+    "paths": {
+      "@/*": ["./src/*"]
+    }
+  },
+  "include": ["src/components/**/*"],
+  "exclude": ["node_modules"]
+}
+

package/tsconfig.json

@@ -0,0 +1,41 @@
+{
+  "compilerOptions": {
+    "lib": [
+      "dom",
+      "dom.iterable",
+      "esnext"
+    ],
+    "noImplicitAny": false,
+    "allowJs": true,
+    "skipLibCheck": true,
+    "strict": true,
+    "noEmit": true,
+    "esModuleInterop": true,
+    "module": "esnext",
+    "moduleResolution": "bundler",
+    "resolveJsonModule": true,
+    "isolatedModules": true,
+    "jsx": "preserve",
+    "incremental": true,
+    "plugins": [
+      {
+        "name": "next"
+      }
+    ],
+    "paths": {
+      "@/*": [
+        "./src/*"
+      ]
+    },
+    "target": "ES2017"
+  },
+  "include": [
+    "next-env.d.ts",
+    "**/*.ts",
+    "**/*.tsx",
+    ".next/types/**/*.ts"
+  ],
+  "exclude": [
+    "node_modules"
+  ]
+}