@indietabletop/appkit 2.0.0 → 3.0.0

package/README.md

@@ -13,7 +13,7 @@ A collection of modules used in Indie Tabletop Club's apps.
 
 ### Hooks
 
-- useAsyncPp
+- useAsyncOp
 - useDocumentBackgroundColor
 - useIsInstalled
 - useMediaQuery

package/dist/async-op.d.ts

@@ -68,6 +68,18 @@ export declare class Failure<FailureValue> implements Operation<never, FailureVa
     mapFailure<MappedFailure>(mappingFn: (value: FailureValue) => MappedFailure): Failure<MappedFailure>;
     unpack<S, F, P>(_mapS: (value: never) => S, mapF: (failure: FailureValue) => F, _mapP: () => P): S | F | P;
 }
+/**
+ * Folds multiple ops into a single op.
+ *
+ * To return a Success, all ops provided must be a Success. If any Failures are
+ * encountered, will return the first one found.
+ *
+ * If neither of these conditions is true, will return Pending.
+ *
+ * Note that if passed an empty array, will always return a Success (with an
+ * empty array as value). This mimics the semantics of many JS constructs, like
+ * Promise.all or Array.prototype.every.
+ */
 export declare function fold<Ops extends readonly AsyncOp<unknown, unknown>[] | []>(ops: Ops): AsyncOp<{
     -readonly [Index in keyof Ops]: Ops[Index] extends AsyncOp<infer S, unknown> ? S : never;
 }, Ops[number] extends AsyncOp<unknown, infer F> ? F : never>;

package/dist/async-op.js

@@ -197,7 +197,21 @@ export class Failure {
         return mapF(this.failure);
     }
 }
+/**
+ * Folds multiple ops into a single op.
+ *
+ * To return a Success, all ops provided must be a Success. If any Failures are
+ * encountered, will return the first one found.
+ *
+ * If neither of these conditions is true, will return Pending.
+ *
+ * Note that if passed an empty array, will always return a Success (with an
+ * empty array as value). This mimics the semantics of many JS constructs, like
+ * Promise.all or Array.prototype.every.
+ */
 export function fold(ops) {
+    // Note that due to the semantics of `every`, if the array provided to `fold`
+    // is empty, the result will be a Success with an empty array.
     if (ops.every((v) => v.isSuccess)) {
         return new Success(ops.map((op) => op.value));
     }

package/dist/client.d.ts

@@ -1,6 +1,6 @@
 import { Failure, Success } from "@indietabletop/appkit/async-op";
-import { Infer, Struct } from "superstruct";
-import { CurrentUser, FailurePayload, SessionInfo } from "./types.js";
+import { type Infer, Struct } from "superstruct";
+import type { CurrentUser, FailurePayload, SessionInfo } from "./types.js";
 export declare class IndieTabletopClient {
     origin: string;
     private onCurrentUser?;
@@ -55,6 +55,7 @@ export declare class IndieTabletopClient {
         email: string;
         password: string;
         acceptedTos: boolean;
+        subscribedToNewsletter: boolean;
     }): Promise<Failure<FailurePayload> | Success<{
         sessionInfo: {
             expiresTs: number;

package/dist/client.js

@@ -1,5 +1,5 @@
 import { Failure, Success } from "@indietabletop/appkit/async-op";
-import { mask, object, string } from "superstruct";
+import { mask, object, string, Struct } from "superstruct";
 import { currentUser, sessionInfo } from "./structs.js";
 export class IndieTabletopClient {
     constructor(props) {
@@ -126,6 +126,7 @@ export class IndieTabletopClient {
                 email: payload.email,
                 plaintextPassword: payload.password,
                 acceptedTos: payload.acceptedTos,
+                subscribedToNewsletter: payload.subscribedToNewsletter,
             },
         });
         if (res.isSuccess) {

package/dist/defineNetlifyConfig.d.ts

@@ -0,0 +1,34 @@
+import type { ConfigEnv, PluginOption, UserConfig } from "vite";
+export declare function defineNetlifyConfig(props: {
+    /**
+     * The server port number.
+     *
+     * Game apps start from 8000, automation apps from 9000. So far, we got:
+     *
+     * - API: 8000
+     * - Hobgoblin: 8001
+     * - Eternol: 8002
+     * - Gregbot: 9000
+     */
+    port: number;
+    /**
+     * By default, react and vanilla extract are always configured.
+     */
+    additionalPlugins?: PluginOption[];
+    /**
+     * Can be used to import from `@` at the path specified here. Has to match
+     * tsconfig > compilerOptions > paths.
+     *
+     * Do not use this, just use relative imports.
+     *
+     * @deprecated
+     */
+    resolveAlias?: string;
+    /**
+     * Determines whether input is "/index.html", or "index.html" or
+     * "/src/main.tsx" depnending on command.
+     *
+     * This is useful when using pre-rendered HTML as input.
+     */
+    conditionalInput?: boolean;
+}): ({ command }: ConfigEnv) => UserConfig;

package/dist/defineNetlifyConfig.js

@@ -0,0 +1,35 @@
+import { vanillaExtractPlugin as vanilla } from "@vanilla-extract/vite-plugin";
+import react from "@vitejs/plugin-react";
+export function defineNetlifyConfig(props) {
+    const { additionalPlugins = [], conditionalInput = false, resolveAlias, } = props;
+    return function configureVite({ command }) {
+        return {
+            define: {
+                // These vars are supplied by Netlify
+                BRANCH: JSON.stringify(process.env.BRANCH),
+                COMMIT_SHORTCODE: JSON.stringify(process.env.COMMIT_REF?.slice(0, 7)),
+            },
+            plugins: [react(), vanilla(), ...additionalPlugins],
+            esbuild: {
+                target: "es2022",
+            },
+            server: {
+                port: props.port,
+            },
+            resolve: {
+                alias: resolveAlias ? { "@": resolveAlias } : undefined,
+            },
+            build: {
+                sourcemap: true,
+                manifest: true,
+                rollupOptions: {
+                    // During `build`, we want to only deal with JS files. Production HTML
+                    // entrypoint is generated via the `build:entrypoint` package script.
+                    input: conditionalInput && command === "build"
+                        ? "/src/main.tsx"
+                        : "/index.html",
+                },
+            },
+        };
+    };
+}

package/dist/external-link.d.ts

@@ -1,4 +1,4 @@
-import { AnchorHTMLAttributes } from "react";
+import type { AnchorHTMLAttributes } from "react";
 type ExternalLinkProps = Omit<AnchorHTMLAttributes<HTMLAnchorElement>, "rel" | "target">;
 export declare function ExternalLink(props: ExternalLinkProps): import("react/jsx-runtime").JSX.Element;
 export {};

package/dist/index.d.ts

@@ -0,0 +1,14 @@
+export * from "./append-copy-to-text.ts";
+export * from "./async-op.ts";
+export * from "./caught-value.ts";
+export * from "./class-names.ts";
+export * from "./client.ts";
+export * from "./external-link.tsx";
+export * from "./structs.ts";
+export * from "./types.ts";
+export * from "./use-async-op.ts";
+export * from "./use-document-background-color.ts";
+export * from "./use-is-installed.ts";
+export * from "./use-media-query.ts";
+export * from "./use-reverting-state.ts";
+export * from "./use-scroll-restoration.ts";

package/dist/index.js

@@ -0,0 +1,14 @@
+export * from "./append-copy-to-text.js";
+export * from "./async-op.js";
+export * from "./caught-value.js";
+export * from "./class-names.js";
+export * from "./client.js";
+export * from "./external-link.js";
+export * from "./structs.js";
+export * from "./types.js";
+export * from "./use-async-op.js";
+export * from "./use-document-background-color.js";
+export * from "./use-is-installed.js";
+export * from "./use-media-query.js";
+export * from "./use-reverting-state.js";
+export * from "./use-scroll-restoration.js";

package/dist/types.d.ts

@@ -1,4 +1,4 @@
-import { Infer } from "superstruct";
+import type { Infer } from "superstruct";
 import { currentUser, sessionInfo } from "./structs.js";
 export type CurrentUser = Infer<ReturnType<typeof currentUser>>;
 export type SessionInfo = Infer<ReturnType<typeof sessionInfo>>;

package/dist/types.js

@@ -1 +1 @@
-export {};
+import { currentUser, sessionInfo } from "./structs.js";

package/dist/use-async-op.d.ts

@@ -1,4 +1,4 @@
-import { AsyncOp } from "./async-op.js";
+import { type AsyncOp } from "./async-op.js";
 export declare function useAsyncOp<T, E>(): {
     op: AsyncOp<T, E>;
     setSuccess: (value: T) => void;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@indietabletop/appkit",
-  "version": "2.0.0",
+  "version": "3.0.0",
   "description": "A collection of modules used in apps built by Indie Tabletop Club",
   "private": false,
   "type": "module",
@@ -24,8 +24,8 @@
   "devDependencies": {
     "@types/react": "^19.0.8",
     "np": "^10.1.0",
-    "typescript": "^5.7.2",
-    "vitest": "^2.1.6"
+    "typescript": "^5.8.2",
+    "vitest": "^3.0.5"
   },
   "dependencies": {
     "superstruct": "^2.0.2"