@viniaraujo68/plinth 0.0.0-stage → 0.2.0

package/dist/user/anonymous.js

@@ -0,0 +1,26 @@
+/**
+ * The user context in force until an app installs its own.
+ *
+ * Nobody is signed in, and every role check answers `true`. That reads backwards for something
+ * whose job is to deny, so it is worth being explicit about why it is the right default.
+ *
+ * A role gate is a *statement about the app's intent*, not a security control — the server is
+ * what actually refuses to serve the data. So the question is only what an unauthenticated
+ * library should do with an intent it has no way to evaluate. Denying would mean a route tree
+ * annotated with `requiredRoles` renders as an empty shell the moment you clone it, and the
+ * annotation would have to be commented out to develop against it. Allowing makes the gates
+ * advisory: they sit in the config, describing the eventual policy, doing nothing, until the
+ * day the app calls `setUserContext` with something that can actually answer. From that call
+ * on, every gate is live at once, with no other edit.
+ *
+ * The failure mode of the opposite choice — an app that ships without ever setting a context
+ * and hides its own UI — is silent and confusing. This one is loud: everything is visible,
+ * `status` says `"anonymous"`, and nothing pretends a user exists.
+ */
+export const anonymousUser = {
+    status: "anonymous",
+    data: null,
+    hasRole: () => true,
+    hasAnyRole: () => true,
+    hasAllRoles: () => true,
+};

package/dist/user/context.d.ts

@@ -0,0 +1,55 @@
+/**
+ * Where the app is in figuring out who the user is.
+ *
+ * Four states, and each one exists because chrome has to render differently for it: nobody is
+ * signed in, we do not know yet, we know, and we tried and failed. Everything finer — token
+ * about to expire, silent renewal in flight, re-authentication required — is the business of
+ * whichever auth library the app chose, and stays there.
+ */
+export type UserStatus = "anonymous" | "loading" | "authenticated" | "error";
+/** The only user fields the library itself renders: an avatar's name and the address under it. */
+export interface UserData {
+    name: string;
+    email: string;
+}
+/**
+ * The seam between an app's authentication and this library's gates.
+ *
+ * Deliberately an interface with no implementation behind it. The library needs to ask two
+ * questions — who is this, and may they see this — and any answer will do: a cookie session
+ * against your own backend, a JWT from a hosted provider, a hard-coded object in a test. None
+ * of that leaks in here, and no dependency comes with it.
+ *
+ * Implementations are expected to be reactive (a class with `$state` fields, typically), since
+ * `ScopedComponent` reads them inside a `$derived`.
+ *
+ * ```ts
+ * import { setUserContext } from "@viniaraujo68/plinth/user";
+ *
+ * setUserContext(myUserStore);
+ * ```
+ */
+export interface UserContext {
+    status: UserStatus;
+    /** `null` unless `status` is `"authenticated"`. */
+    data: UserData | null;
+    hasRole: (role: string) => boolean;
+    /** True when `roles` is empty — an ungated resource is open to everyone. */
+    hasAnyRole: (roles: readonly string[]) => boolean;
+    /** True when `roles` is empty, for the same reason as `hasAnyRole`. */
+    hasAllRoles: (roles: readonly string[]) => boolean;
+    /** Present only if the app has somewhere to sign out to. Shell chrome hides its sign-out
+     * control when it is missing rather than rendering a button that does nothing. */
+    logout?: () => void | Promise<void>;
+}
+declare const setUserContext: (context: UserContext) => UserContext;
+/**
+ * The user context for the current component tree, or {@link anonymousUser} when the app never
+ * set one.
+ *
+ * The fallback is what lets a component that gates on roles be dropped into an app with no
+ * authentication at all and still render. Like every context read, this has to run while the
+ * component is initialising.
+ */
+export declare const getUserContext: () => UserContext;
+export { setUserContext };

package/dist/user/context.js

@@ -0,0 +1,13 @@
+import { createContext } from "svelte";
+import { anonymousUser } from "./anonymous.js";
+const [readUserContext, setUserContext, hasUserContext] = createContext();
+/**
+ * The user context for the current component tree, or {@link anonymousUser} when the app never
+ * set one.
+ *
+ * The fallback is what lets a component that gates on roles be dropped into an app with no
+ * authentication at all and still render. Like every context read, this has to run while the
+ * component is initialising.
+ */
+export const getUserContext = () => hasUserContext() ? readUserContext() : anonymousUser;
+export { setUserContext };

package/dist/user/index.d.ts

@@ -0,0 +1,3 @@
+export { anonymousUser } from "./anonymous.js";
+export { getUserContext, setUserContext, type UserContext, type UserData, type UserStatus, } from "./context.js";
+export { default as ScopedComponent } from "./ScopedComponent.svelte";

package/dist/user/index.js

@@ -0,0 +1,6 @@
+// The identity seam, and nothing more. There is no store, no provider and no network call here
+// on purpose: the library only ever needs to ask who the user is and whether they hold a role,
+// and every app answers that differently. `@viniaraujo68/plinth/user`.
+export { anonymousUser } from "./anonymous.js";
+export { getUserContext, setUserContext, } from "./context.js";
+export { default as ScopedComponent } from "./ScopedComponent.svelte";

package/package.json

@@ -1,6 +1,135 @@
 {
   "name": "@viniaraujo68/plinth",
-  "version": "0.0.0-stage",
-  "stub": true,
-  "description": "Temporary package placeholder for staged publishing"
-}
+  "version": "0.2.0",
+  "description": "A personal Svelte 5 design system: theme, application shell, interface primitives, routing metadata, a fetch wrapper and locale-aware formatters.",
+  "license": "MIT",
+  "type": "module",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/viniaraujo68/plinth.git"
+  },
+  "homepage": "https://viniaraujo68.github.io/plinth",
+  "bugs": {
+    "url": "https://github.com/viniaraujo68/plinth/issues"
+  },
+  "keywords": [
+    "svelte",
+    "svelte5",
+    "sveltekit",
+    "design-system",
+    "component-library",
+    "tailwindcss",
+    "daisyui"
+  ],
+  "scripts": {
+    "dev": "vite dev",
+    "build": "vite build && npm run prepack",
+    "preview": "vite preview",
+    "prepare": "svelte-kit sync && svelte-package",
+    "prepack": "svelte-kit sync && svelte-package && publint",
+    "check": "svelte-kit sync && svelte-check --tsconfig ./tsconfig.json",
+    "check:watch": "svelte-kit sync && svelte-check --tsconfig ./tsconfig.json --watch",
+    "lint": "prettier --check . && eslint .",
+    "format": "prettier --write .",
+    "test:unit": "vitest",
+    "test": "npm run test:unit -- --run && npm run test:e2e",
+    "test:e2e": "playwright install chromium && playwright test"
+  },
+  "files": [
+    "dist",
+    "!dist/**/*.test.*",
+    "!dist/**/*.spec.*",
+    "!dist/**/*.e2e.*"
+  ],
+  "sideEffects": [
+    "**/*.css"
+  ],
+  "svelte": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "svelte": "./dist/index.js"
+    },
+    "./theme": {
+      "types": "./dist/theme/index.d.ts",
+      "svelte": "./dist/theme/index.js"
+    },
+    "./theme.css": "./dist/theme/theme.css",
+    "./attachments": {
+      "types": "./dist/attachments/index.d.ts",
+      "svelte": "./dist/attachments/index.js"
+    },
+    "./components": {
+      "types": "./dist/components/index.d.ts",
+      "svelte": "./dist/components/index.js"
+    },
+    "./confirm": {
+      "types": "./dist/confirm/index.d.ts",
+      "svelte": "./dist/confirm/index.js"
+    },
+    "./shell": {
+      "types": "./dist/shell/index.d.ts",
+      "svelte": "./dist/shell/index.js"
+    },
+    "./table": {
+      "types": "./dist/table/index.d.ts",
+      "svelte": "./dist/table/index.js"
+    },
+    "./toast": {
+      "types": "./dist/toast/index.d.ts",
+      "svelte": "./dist/toast/index.js"
+    },
+    "./routing": {
+      "types": "./dist/routing.svelte.d.ts",
+      "svelte": "./dist/routing.svelte.js"
+    },
+    "./user": {
+      "types": "./dist/user/index.d.ts",
+      "svelte": "./dist/user/index.js"
+    },
+    "./http": {
+      "types": "./dist/http.d.ts",
+      "default": "./dist/http.js"
+    },
+    "./formatters": {
+      "types": "./dist/formatters.d.ts",
+      "default": "./dist/formatters.js"
+    },
+    "./package.json": "./package.json"
+  },
+  "peerDependencies": {
+    "@sveltejs/kit": "^2.0.0",
+    "svelte": "^5.57.0"
+  },
+  "devDependencies": {
+    "@eslint/js": "^10.0.1",
+    "@playwright/test": "^1.60.0",
+    "@sveltejs/adapter-static": "^3.0.10",
+    "@sveltejs/kit": "^2.63.0",
+    "@sveltejs/package": "^2.5.8",
+    "@sveltejs/vite-plugin-svelte": "^7.1.2",
+    "@tailwindcss/vite": "^4.3.0",
+    "@types/node": "^24",
+    "@vitest/browser-playwright": "^4.1.8",
+    "daisyui": "^5.6.10",
+    "eslint": "^10.4.1",
+    "eslint-config-prettier": "^10.1.8",
+    "eslint-plugin-svelte": "^3.19.0",
+    "globals": "^17.6.0",
+    "playwright": "^1.60.0",
+    "prettier": "^3.8.3",
+    "prettier-plugin-svelte": "^4.1.0",
+    "prettier-plugin-tailwindcss": "^0.8.0",
+    "publint": "^0.3.21",
+    "svelte": "^5.57.0",
+    "svelte-check": "^4.6.0",
+    "tailwindcss": "^4.3.0",
+    "typescript": "^6.0.3",
+    "typescript-eslint": "^8.60.1",
+    "vite": "^8.0.16",
+    "vite-plugin-devtools-json": "^1.1.0",
+    "vitest": "^4.1.8",
+    "vitest-browser-svelte": "^2.1.1"
+  }
+}